Jump to

• Request
• Response

Get an Order Base

get

/orderBases/{orderBaseGid}

Request

Path Parameters

• orderBaseGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• accessorials: accessorials
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeCurrency2: attributeCurrency2
  The attribute currency of the shipment.
• attributeCurrency3: attributeCurrency3
  The attribute currency of the shipment.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• bundlingType: string
  The bundling type is automatic or manual only allow bundling; they are distinguished only by user defined queries. Bundling type of do not bundle means order will never be bundled with other orders.
• customerUnitizationRequest: boolean
  The customer's request for unitization location.
• defaultStowageModeGid: string
  The default stowage mode to use for this order when loading onto stowage consol shipments.
• destuffLocation: destuffLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destuffLocationGid: string
  The location for destuffing (unloading) the container after the ocean move.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dimRateFactorGid: string
  The dim factor to be used when allocating by dimensional weight for a business unit and rate calculations.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• dropoffRoutingSequenceGid: string
  The dropoff location routing sequence that controls how the stops can be planned for pickup such as first, absolute first, last.
• effectiveDate: effectiveDate
  Effective date of the order.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  The buy equipment group GID can be defined to force the order release to be schedule with a constrained equipment group. This value is copied to any associated order releases.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentGroupProfileGid: string
  The buy equipment group profile GID can be defined to force the order release to be schedule with a constrained equipment group profile. This value is copied to any associated order releases.
• expirationDate: expirationDate
  The expiration date of the order.
• externalSystemId: string
  The identifier for the external system that provided the base order. For example a user's Oracle or other ERP system could be providing the order IDs.
• fixedItinerary: fixedItinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• fixedItineraryGid: string
  The fixed buy side itinerary GID can be defined to force the order release to be schedule with a constrained itinerary. This value is copied to any associated order releases.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• fixedSellItinerary: fixedSellItinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• fixedSellItineraryGid: string
  The fixed buy side itinerary GID can be defined to force the order release to be schedule with a constrained itinerary This value is copied to any associated order releases.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• incoTermGid: string
  The INCO term GID contains the GID for the incoterms associated with the order base.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isIgnoreLocationCalendar: boolean
  A Y/N indicator for whether to ignore the source and destination calendar when planning the order.
• isKnownShipper: boolean
  A Y/N indicator for whether the shipper involved party is a known shipper for air travel.
• isTemplate: boolean
  A Y/N flag to identify if this order is just a template and order base (s) can be created out of it. This attribute is marked as Create-Only.
• legConstraints: legConstraints
• lines: lines
• links: array links
  Read Only: true
• modeProfileGid: string
  The buy mode profile GID can be defined to force the order release to be schedule with a constrained transport mode profile. This value is copied to any associated order releases.
• mustShipDirect: boolean
  A Y/N indicator for whether this order release must ship direct.
• mustShipThruPool: boolean
  A Y/N indicator for whether this order release must ship through pool.
• mustShipThruXDock: boolean
  A Y/N indicator for whether this order release must ship through cross dock.
• orderBaseGid: string
  The GID for the order base.
• orderBaseXid: string
  The XID for the order base.
• orderTypeGid: string
  The order type GID contains the unique identifier for the order type. Examples of order types include: CUSTOMER_ORDERS INTERFACILITY RETURNS INTEGRATION WEB
• paymentMethodCodeGid: string
  The payment method GID contains the GID for the payment method code for the order. Examples of payment method include electronic fund transfer and cash on delivery.
• pickupRoutingSequenceGid: string
  The pickup location routing sequence that controls how the stops can be planned for pickup such as first, absolute first, last.
• planningGroupGid: string
  The planning group GID used to group orders into different bulk planning waves.
• priority: number (int32)
  The priority value assigned to the order base.
• processingCodeGid: string
  A unique pointer to define the processing codes in the system. The system has only one processing code, "PLN", which means to plan the shipment from the order release.
• rateGeoGid: string
  The buy rate geography details GID can be defined to force the order release to be schedule with a constrained rate detail. This value is copied to any associated order releases.
• rateOfferingGid: string
  The buy rate offering GID can be defined to force the order release to be schedule with a constrained rate offering. This value is copied to any associated order releases.
• rateServiceGid: string
  The buy rate service GID can be defined to force the order release to be schedule with a constrained rate service. This value is copied to any associated order releases.
• rateServiceProfileGid: string
  The buy rate service profile GID can be defined to force the order release to be schedule with a constrained rate service profile. This value is copied to any associated order releases.
• refnums: refnums
• releaseMethodGid: string
  The release method GID is the order configuration rule and this drives the configuration of the order such as ship unit or line as well as various calculations. This attribute is marked as Create-Only.
• remarks: remarks
• sellRateGeoGid: string
  The sell rate geography details GID can be defined to force the order release to be schedule with a constrained rate detail. This value is copied to any associated order releases.
• sellRateOfferingGid: string
  The sell rate offering GID can be defined to force the order release to be schedule with a constrained rate offering. This value is copied to any associated order releases.
• sellServprov: sellServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sellServprovGid: string
  The sell service provider GID can be defined to force the order release to be schedule with a constrained service provider. This value is copied to any associated order releases.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sellServprovProfileGid: string
  The sell service provider profile GID can be defined to force the order release to be schedule with a constrained service provider profile. This value is copied to any associated order releases.
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The buy service provider GID can be defined to force the order release to be schedule with a constrained service provider. This value is copied to any associated order releases.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprovProfileGid: string
  The buy service provider profile GID can be defined to force the order release to be schedule with a constrained service provider profile. This value is copied to any associated order releases.
• shipUnits: shipUnits
• shipWithGroup: string
  Read Only: true

  Currently not supported. Ship with group is on the order base ship unit and order base line level.
• specialServices: specialServices
• statuses: statuses
• stuffLocation: stuffLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• stuffLocationGid: string
  The location for stuffing (loading) the container prior to shipping.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• termLocationText: string
  The term location text contains additional information related to the incoterms for the order.
• texts: texts
• timeWindowEmphasisGid: string
  The time window emphasis GID contains the unique identifier to tell the planning engine whether early or late (or both) pickup and delivery times are important when creating a shipment.
• totalDeclaredValue: totalDeclaredValue
  Read Only: true

  The total declared value calculated from the order base lines.
• totalNetVolume: totalNetVolume
  Read Only: true

  The total net volume calculated from the order release lines.
• totalNetWeight: totalNetWeight
  Read Only: true

  The total net weight calculated from the order release lines.
• totalVolume: totalVolume
  Read Only: true

  The total gross volume calculated from the order base lines.
• totalWeight: totalWeight
  Read Only: true

  The total gross weight calculated from the order base lines.
• trackingEvents: trackingEvents
• transportModeGid: string
  The buy transport mode GID can be defined to force the order release to be schedule with a constrained transport mode. This value is copied to any associated order releases.
• unitizationConditionName: string
  The unitization (loading of equipment) condition name value.
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.
• userDefined2IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.
• userDefined3IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.
• userDefined4IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.
• userDefined5IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.

{
    "properties":{
        "orderBaseGid":{
            "description":"The GID for the order base.",
            "type":"string"
        },
        "orderBaseXid":{
            "description":"The XID for the order base.",
            "type":"string"
        },
        "externalSystemId":{
            "description":"The identifier for the external system that provided the base order. For example a user's Oracle or other ERP system could be providing the order IDs.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method GID contains the GID for the payment method code for the order. Examples of payment method include electronic fund transfer and cash on delivery.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The INCO term GID contains the GID for the incoterms associated with the order base.",
            "type":"string"
        },
        "termLocationText":{
            "description":"The term location text contains additional information related to the incoterms for the order.",
            "type":"string"
        },
        "planningGroupGid":{
            "description":"The planning group GID used to group orders into different bulk planning waves.",
            "type":"string"
        },
        "fixedItineraryGid":{
            "description":"The fixed buy side itinerary GID can be defined to force the order release to be schedule with a constrained itinerary. This value is copied to any associated order releases. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "fixedItinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "orderTypeGid":{
            "description":"The order type GID contains the unique identifier for the order type. Examples of order types include: CUSTOMER_ORDERS INTERFACILITY RETURNS INTEGRATION WEB",
            "type":"string"
        },
        "timeWindowEmphasisGid":{
            "description":"The time window emphasis GID contains the unique identifier to tell the planning engine whether early or late (or both) pickup and delivery times are important when creating a shipment.",
            "type":"string"
        },
        "rateServiceProfileGid":{
            "description":"The buy rate service profile GID can be defined to force the order release to be schedule with a constrained rate service profile. This value is copied to any associated order releases.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The buy service provider GID can be defined to force the order release to be schedule with a constrained service provider. This value is copied to any associated order releases. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "servprovProfileGid":{
            "description":"The buy service provider profile GID can be defined to force the order release to be schedule with a constrained  service provider profile. This value is copied to any associated order releases.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The buy transport mode GID can be defined to force the order release to be schedule with a constrained  transport mode. This value is copied to any associated order releases.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The buy mode profile GID can be defined to force the order release to be schedule with a constrained  transport mode profile. This value is copied to any associated order releases.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"The buy equipment group GID can be defined to force the order release to be schedule with a constrained equipment group. This value is copied to any associated order releases. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "equipmentGroupProfileGid":{
            "description":"The buy equipment group profile GID can be defined to force the order release to be schedule with a constrained equipment group profile. This value is copied to any associated order releases.",
            "type":"string"
        },
        "processingCodeGid":{
            "description":"A unique pointer to define the processing codes in the system. The system has only one processing code, \"PLN\", which means to plan the shipment from the order release.",
            "type":"string"
        },
        "shipWithGroup":{
            "description":"Currently not supported. Ship with group is on the order base ship unit and order base line level.",
            "type":"string",
            "readOnly":true
        },
        "effectiveDate":{
            "description":"Effective date of the order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of the order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isTemplate":{
            "description":"A Y/N flag to identify if this order is just a template and order base (s) can be created out of it. This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "rateOfferingGid":{
            "description":"The buy rate offering GID can be defined to force the order release to be schedule with a constrained rate offering. This value is copied to any associated order releases.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The buy rate geography details GID can be defined to force the order release to be schedule with a constrained rate detail. This value is copied to any associated order releases.",
            "type":"string"
        },
        "sellRateOfferingGid":{
            "description":"The sell rate offering GID can be defined to force the order release to be schedule with a constrained rate offering. This value is copied to any associated order releases.",
            "type":"string"
        },
        "sellRateGeoGid":{
            "description":"The sell rate geography details GID can be defined to force the order release to be schedule with a constrained rate detail. This value is copied to any associated order releases.",
            "type":"string"
        },
        "fixedSellItineraryGid":{
            "description":"The fixed buy side itinerary GID can be defined to force the order release to be schedule with a constrained itinerary This value is copied to any associated order releases. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "fixedSellItinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "totalWeight":{
            "description":"The total gross weight calculated from the order base lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "totalVolume":{
            "description":"The total gross volume calculated from the order base lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "mustShipDirect":{
            "description":"A Y/N indicator for whether this order release must ship direct.",
            "type":"boolean"
        },
        "mustShipThruXDock":{
            "description":"A Y/N indicator for whether this order release must ship through cross dock.",
            "type":"boolean"
        },
        "mustShipThruPool":{
            "description":"A Y/N indicator for whether this order release must ship through pool.",
            "type":"boolean"
        },
        "isKnownShipper":{
            "description":"A Y/N indicator for whether the shipper involved party is a known shipper for air travel.",
            "type":"boolean"
        },
        "releaseMethodGid":{
            "description":"The release method GID is the order configuration rule and this drives the configuration of the order such as ship unit or line as well as various calculations. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "totalNetWeight":{
            "description":"The total net weight calculated from the order release lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "totalNetVolume":{
            "description":"The total net volume calculated from the order release lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "dimRateFactorGid":{
            "description":"The dim factor to be used when allocating by dimensional weight for a business unit and rate calculations.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order base.",
            "type":"string"
        },
        "bundlingType":{
            "description":"The bundling type is automatic or manual only allow bundling; they are distinguished only by user defined queries.  Bundling type of do not bundle means order will never be bundled with other orders.",
            "type":"string"
        },
        "totalDeclaredValue":{
            "description":"The total declared value calculated from the order base lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ],
            "readOnly":true
        },
        "sellServprovGid":{
            "description":"The sell service provider GID can be defined to force the order release to be schedule with a constrained service provider. This value is copied to any associated order releases. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sellServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "sellServprovProfileGid":{
            "description":"The sell service provider profile GID can be defined to force the order release to be schedule with a constrained service provider profile. This value is copied to any associated order releases.",
            "type":"string"
        },
        "rateServiceGid":{
            "description":"The buy rate service GID can be defined to force the order release to be schedule with a constrained rate service. This value is copied to any associated order releases.",
            "type":"string"
        },
        "defaultStowageModeGid":{
            "description":"The default stowage mode to use for this order when loading onto stowage consol shipments.",
            "type":"string"
        },
        "stuffLocationGid":{
            "description":"The location for stuffing (loading) the container prior to shipping. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "stuffLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destuffLocationGid":{
            "description":"The location for destuffing (unloading) the container after the ocean move. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destuffLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "customerUnitizationRequest":{
            "description":"The customer's request for unitization location.",
            "type":"boolean"
        },
        "unitizationConditionName":{
            "description":"The unitization (loading of equipment) condition name value.",
            "type":"string"
        },
        "isIgnoreLocationCalendar":{
            "description":"A Y/N indicator for whether to ignore the source and destination calendar when planning the order.",
            "type":"boolean"
        },
        "pickupRoutingSequenceGid":{
            "description":"The pickup location routing sequence that controls how the stops can be planned for pickup such as first, absolute first, last.",
            "type":"string"
        },
        "dropoffRoutingSequenceGid":{
            "description":"The dropoff location routing sequence that controls how the stops can be planned for pickup such as first, absolute first, last.",
            "type":"string"
        },
        "priority":{
            "description":"The priority value assigned to the order base.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "lines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "legConstraints":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.legConstraints"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "trackingEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.trackingEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : destuffLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

Effective date of the order.

Match All

Effective date of the order.

Show Source

• object dateTimeType

{
    "description":"Effective date of the order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : expirationDate

The expiration date of the order.

Match All

The expiration date of the order.

Show Source

• object dateTimeType

{
    "description":"The expiration date of the order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : fixedItinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : fixedSellItinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : legConstraints

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.legConstraints"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sellServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : shipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stuffLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalDeclaredValue

Read Only: true

The total declared value calculated from the order base lines.

Match All

The total declared value calculated from the order base lines.

Show Source

• object currencyType

{
    "description":"The total declared value calculated from the order base lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ],
    "readOnly":true
}

Nested Schema : totalNetVolume

Read Only: true

The total net volume calculated from the order release lines.

Match All

The total net volume calculated from the order release lines.

Show Source

• object amountType

{
    "description":"The total net volume calculated from the order release lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : totalNetWeight

Read Only: true

The total net weight calculated from the order release lines.

Match All

The total net weight calculated from the order release lines.

Show Source

• object amountType

{
    "description":"The total net weight calculated from the order release lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : totalVolume

Read Only: true

The total gross volume calculated from the order base lines.

Match All

The total gross volume calculated from the order base lines.

Show Source

• object amountType

{
    "description":"The total gross volume calculated from the order base lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : totalWeight

Read Only: true

The total gross weight calculated from the order base lines.

Match All

The total gross weight calculated from the order base lines.

Show Source

• object amountType

{
    "description":"The total gross weight calculated from the order base lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : trackingEvents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.trackingEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.accessorials

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.accessorials

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code used to specify that this accessorial needs to be covered when planning the shipment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The accessorial code used to specify that this accessorial needs to be covered when planning the shipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : locations

Type: object

Show Source

• accessorials: accessorials
• addresses: addresses
• addressUpdateDate: addressUpdateDate
  Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.
• addressValidationEde: string
  Indicates which external distance engine is used to validate the location.
• allowDriverRest: boolean
  Indicates if a driver is allowed to take a rest period at this location if he runs out of available HOS.
• appointDisplay: appointDisplay
  The duration of appointment display time period.
• appointDisplayStartTime: number (int32)
  The start time of appointment view display.
• appointmentActivityType: string
  Appointment activity type refers to whether the appointment if for a drop trailer or live unload scenario.
• apptAfterCutoff: apptAfterCutoff
  Service provider appointment duration after cutoff.
• apptBeforeCutoff: apptBeforeCutoff
  Service provider appointment duration before cutoff.
• apptCutoffHours: number (double)
  Service provider appointment cutoff in hours.
• apptEnforceActTimeSg: boolean
  Enforce Activity Time for shipment group appointments.
• apptObjectType: string
  Indicates the types of appointment objects this location handles. Shipments, Shipment Groups or both Shipments and Shipment Groups.
• apptSearchDays: number (double)
  Use the Appointment Search Days field to override the value of the glog.appointment.searchDays property for this location. Set this field to control the number of days to look forward for the first feasible appointment.
• apptShowNumberOfOptions: number (double)
  Use the Appointment Show Number Of Options field to override the value of the glog.appointment.scheduleAppointmentShowOptions.numberOfAppointments property for this location. Set this field to control how many appointments are displayed when running the Schedule Appointment - Show Options action on the Appointment Management page.
• apptStartTimeToleranceSecs: number (int32)
  Stores tolerance value for appointment start time in seconds.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• bbIsNewStore: boolean
  Indicates if this location should be treated as a new store by the Batch Balancer logic. New stores can only be assigned by Batch Balancer to a DOOR whose LOAD_NEW_STORE field is set to Y.
• bbMaxCasesPerBatch: number (double)
  Maximum number of cases allowed in each batch. If blank, the system will assume that there is no limit. If the number of cases in the order exceeds this maximum, then the batch balancer's splitting logic will distribute the cases into multiple batches uniformly while honoring certain rules.
• bbOrderSplitMethod: string
  Value of "CONVEYABLE" causes only conveyable cases to be counted toward max cases, value of "ALL" causes all cases (including non-con and repack) to count toward max cases.
• capacityGroups: capacityGroups
• city: string
  The name of the city for the location.
• contacts: contacts
• corporations: corporations
• countryCode3Gid: string
  A GID to define the three digit country code.
• countyQualifier: string
  County Qualifier is used when calling an external distance engine and using an address type of city instead of postal code. Often, there are two cities or towns with the same name in one state. For example, in Pennsylvania there is more than one town with the name "Newtown". If you do not combine the town with a postal code or a county, you may not get the result you want.
  You can manually add values; however, you probably want to import them from the external distance engine that you are using. The county qualifier needs to correspond with the distance engine that you are using.
• deliveryGroupName: string
  Another way of grouping the locations.
• description: string
  Free text to capture different location types or classifications like customer, vendor site, or stores etc.
• destArbLevelOfServiceGid: string
  Preferred destination arbitrary level of service when selecting the destination arbitrary for a location during bulkplan.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• dropoffRoutingSequenceGid: string
  Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.
• enforceTimeWindowAppoint: boolean
  Whether or not to enforce the pick up or delivery time window during appointment schedule process."USE_APPOINTMENT_PRIORITY" takes precedence of "ENFORCE_TIME_WINDOW_APPOINT".
• equipmentGroupProfileGid: string
  The GID for the equipment group profile. An Equipment Group Profile is used to categorize Equipment groups by some common attribute or grouping scheme. For example, you can create a Group Profile called Dry Vans that include the 28 FT Dry Van and 24 FT Dry Van (and others if you like) Equipment Groups.
  An Equipment Group Profile consists of an ID and a Profile Name and a collection of specific Equipment Groups that you associate with the profile. Oracle Transportation Management can use the Profile in planning to limit the Equipment Groups that can be used for shipment planning. When Oracle Transportation Management bundles orders and builds shipments, it checks that there is an intersection between the equipment group values identified on the order bases.
  Example: Equipment Group Rule
• erpcGid: string
  The Eastern Region Presidents Commission Code for this Location.
• eruGrouping: string
  To indicate orders going to this location will be grouped together for ERU grouping.
• excludeFromRouteExecution: boolean
  When = Y, this location is excluded from any Route Instance Legs.
• hasMultipleMatches: string
  Indicates if we have multiple matches for the location after address validation.
• insertDate: insertDate
  Read Only: true

  insert date
• isActive: boolean
  Used to activate or deactivate location. When the value is 'N', it can restrain user from planning order to or from the inactive location; from tendering shipment with inactive location.
• isAddressValid: string
  Indicates if the address is considered valid (by checking against the POSTAL_CODE_VALIDATE table).
• isFixedAddress: boolean
  Y/N if address is only allowed to be edited by the UI.
• isLtlSplitable: boolean
  The LTL Splittable check box indicates whether orders from or to this location are permitted to apply the LTL splitting logic. If the check box is not selected, the LTL splitting is disallowed for orders associated with this location.
• isMakeApptBeforePlan: boolean
  A true or false flag to identify if an appointment is required at the location for (example) for pickup, delivery etc.
• isShipperKnown: boolean
  The Known Shipper check box indicates if a shipper is known or unknown. Shippers are considered unknown if they have not filed the appropriate paperwork and gained permission to ship goods on passenger flights. Goods transported by these shippers must be placed on cargo flights. Select Known Shipper if orders coming from this location can be qualified as known, and therefore transported on passenger flights.
• isTemplate: boolean
  Identifies if the location record is a template or represents a physical location.
• isTemporary: boolean
  A flag to identify if the location is created temporarily for a certain shipment or order. This location will not be used for other shipments or processes.
• isWmsFacility: boolean
  Indicates if the location is a warehouse management system facility.
• lat: number (double)
  The latitude for the location.
• links: array links
  Read Only: true
• loadUnloadPoints: loadUnloadPoints
• locationGid: string
  The GID for the location.
• locationGroupGid: string
  The GID for the location group for the location.
• locationName: string
  The name of the location.
• locationXid: string
  The XID for the location.
• lon: number (double)
  The longitude of the location.
• numOfRowsInYard: number (int32)
  The total number of rows in the yard of the location.
• numOfSlotsPerRowInYard: number (int32)
  The number of slots per row in the yard of the location.
• operationalLocations: operationalLocations
• overallQuality: string
  Indicates the overall quality of the location.
• pickupRoutingSequenceGid: string
  Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.
• postalCode: string
  The postal code for the location.
• postalSplcGid: string
  The Postal Standard Point Location Code for this Location.
• primaryAddressLineSeq: number (int64)
  The Address Line Number or primary address line sequence number designates which line of the address text box contains the actual street address so when using the External Distance Engine, the correct street address is used.
  For example, if you had this address in the text box, the line number would be 2.
  Care of Someone
  1234 Main St.
  
• province: string
  The province (or U.S. state) for the location.
• provinceCode: string
  The abbreviation for the province (or U.S. state) for the location.
• railJunctionCodeGid: string
  The Rail Junction Code for this Location.
• railSplcGid: string
  The Rail Standard Point Location Code for this Location.
• railStationCodeGid: string
  The Rail Station Code for this Location.
• rateClassificationGid: string
  The GID for the rate classification. Examples include: COMMERCIAL and RESIDENTIAL.
• refnums: refnums
• regionGid: string
  The GID for the region.
• remarks: remarks
• resourceGroups: resourceGroups
• resourceTypes: resourceTypes
• roleProfiles: roleProfiles
• scheduleInfeasibleAppoint: boolean
  Whether or not to schedule appointment if the appointment time available is out of pick up or delivery time window.
• scheduleLowPriorityAppoint: boolean
  Whether or not to schedule appointment for low priority appointment that has been bumped off.
• servingServprovProfileGid: string
  The Serving Service Provider Profile for this Location.
• servprovPrefs: servprovPrefs
• servprovProfileGid: string
  The GID for the service provider for the location.
• shuttleLotEqGrpProfileGid: string
  This specifies the equipment group profile for the shuttle or parking lot of a location. When a shipment uses one of the equipment groups in this equipment group profile, the location cannot be directly accessed for pickup/delivery and is accessed only through the shuttle lot. In this case, additional shuttle lot activity time is computed and added to the activity time at the location.
• slotTimeInterval: slotTimeInterval
  The smallest appointment slot interval for the location.
• sourcingGroupName: string
  Another way of grouping the locations.
• specialServices: specialServices
• srcArbLevelOfServiceGid: string
  Preferred source arbitrary level of service when selecting the source arbitrary for a location during bulkplan.
• standingApptCutoffWindow: number (int32)
  The cutoff window by which unbooked standing appointments to be released.
• statuses: statuses
• substitutes: substitutes
• timeZoneGid: string
  The GID for the time zone of the location. Examples of time zones include America/Curacao and Europe/Monaco.
• updateDate: updateDate
  Read Only: true

  update date
• useAppointmentPriority: boolean
  Whether or not to consider appointment priority.
• useSingleServprovRule: string
  This specifies the use of single service provider rule at a location. The options are: null - rule is not used, P - for pickups only, D - for deliveries only, B - for both pickups and deliveries.
• yardRowLabels: string
  Comma separated list of labels for rows in a yard.
• yardSlotLabels: string
  Comma separated list of labels for slots in a yard.
• zone1: string
  The zone where the location fits in.
• zone2: string
  The zone where the location fits in.
• zone3: string
  The zone where the location fits in.
• zone4: string
  The zone where the location fits in.

{
    "properties":{
        "locationGid":{
            "description":"The GID for the location.",
            "type":"string"
        },
        "locationXid":{
            "description":"The XID for the location.",
            "type":"string"
        },
        "locationName":{
            "description":"The name of the location.",
            "type":"string"
        },
        "city":{
            "description":"The name of the city for the location.",
            "type":"string"
        },
        "province":{
            "description":"The province (or U.S. state) for the location.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The abbreviation for the province (or U.S. state) for the location.",
            "type":"string"
        },
        "postalCode":{
            "description":"The postal code for the location.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"A GID to define the three digit country code.",
            "type":"string"
        },
        "zone1":{
            "description":"The zone where the location fits in.",
            "type":"string"
        },
        "zone2":{
            "description":"The zone where the location fits in.",
            "type":"string"
        },
        "zone3":{
            "description":"The zone where the location fits in.",
            "type":"string"
        },
        "zone4":{
            "description":"The zone where the location fits in.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The GID for the time zone of the location. Examples of time zones include America/Curacao and Europe/Monaco.",
            "type":"string"
        },
        "lat":{
            "description":"The latitude for the location.",
            "type":"number",
            "format":"double"
        },
        "lon":{
            "description":"The longitude of the location.",
            "type":"number",
            "format":"double"
        },
        "sourcingGroupName":{
            "description":"Another way of grouping the locations.",
            "type":"string"
        },
        "deliveryGroupName":{
            "description":"Another way of grouping the locations.",
            "type":"string"
        },
        "regionGid":{
            "description":"The GID for the region.",
            "type":"string"
        },
        "servprovProfileGid":{
            "description":"The GID for the service provider for the location.",
            "type":"string"
        },
        "locationGroupGid":{
            "description":"The GID for the location group for the location.",
            "type":"string"
        },
        "isTemporary":{
            "description":"A flag to identify if the location is created temporarily for a certain shipment or order. This location will not be used for other shipments or processes.",
            "type":"boolean"
        },
        "isMakeApptBeforePlan":{
            "description":"A true or false flag to identify if an appointment is required at the location for (example) for pickup, delivery etc.",
            "type":"boolean"
        },
        "isShipperKnown":{
            "description":"The Known Shipper check box indicates if a shipper is known or unknown. Shippers are considered unknown if they have not filed the appropriate paperwork and gained permission to ship goods on passenger flights. Goods transported by these shippers must be placed on cargo flights. Select Known Shipper if orders coming from this location can be qualified as known, and therefore transported on passenger flights.",
            "type":"boolean"
        },
        "isAddressValid":{
            "description":"Indicates if the address is considered valid (by checking against the POSTAL_CODE_VALIDATE table).",
            "type":"string"
        },
        "rateClassificationGid":{
            "description":"The GID for the rate classification. Examples include: COMMERCIAL and RESIDENTIAL.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"The GID for the equipment group profile. An Equipment Group Profile is used to categorize Equipment groups by some common attribute or grouping scheme. For example, you can create a Group Profile called Dry Vans that include the 28 FT Dry Van and 24 FT Dry Van (and others if you like) Equipment Groups.<br>An Equipment Group Profile consists of an ID and a Profile Name and a collection of specific Equipment Groups that you associate with the profile. Oracle Transportation Management can use the Profile in planning to limit the Equipment Groups that can be used for shipment planning. When Oracle Transportation Management bundles orders and builds shipments, it checks that there is an intersection between the equipment group values identified on the order bases.<br>Example: Equipment Group Rule",
            "type":"string"
        },
        "slotTimeInterval":{
            "description":"The smallest appointment slot interval for the location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isLtlSplitable":{
            "description":"The LTL Splittable check box indicates whether orders from or to this location are permitted to apply the LTL splitting logic. If the check box is not selected, the LTL splitting is disallowed for orders associated with this location.",
            "type":"boolean"
        },
        "numOfRowsInYard":{
            "description":"The total number of rows in the yard of the location.",
            "type":"number",
            "format":"int32"
        },
        "numOfSlotsPerRowInYard":{
            "description":"The number of slots per row in the yard of the location.",
            "type":"number",
            "format":"int32"
        },
        "useAppointmentPriority":{
            "description":"Whether or not to consider appointment priority.",
            "type":"boolean"
        },
        "scheduleLowPriorityAppoint":{
            "description":"Whether or not to schedule appointment for low priority appointment that has been bumped off.",
            "type":"boolean"
        },
        "enforceTimeWindowAppoint":{
            "description":"Whether or not to enforce the pick up or delivery time window during appointment schedule process.\"USE_APPOINTMENT_PRIORITY\" takes precedence of \"ENFORCE_TIME_WINDOW_APPOINT\".",
            "type":"boolean"
        },
        "scheduleInfeasibleAppoint":{
            "description":"Whether or not to schedule appointment if the appointment time available is out of pick up or delivery time window.",
            "type":"boolean"
        },
        "countyQualifier":{
            "description":"County Qualifier is used when calling an external distance engine and using an address type of city instead of postal code. Often, there are two cities or towns with the same name in one state. For example, in Pennsylvania there is more than one town with the name \"Newtown\". If you do not combine the town with a postal code or a county, you may not get the result you want.<br>You can manually add values; however, you probably want to import them from the external distance engine that you are using. The county qualifier needs to correspond with the distance engine that you are using.",
            "type":"string"
        },
        "bbMaxCasesPerBatch":{
            "description":"Maximum number of cases allowed in each batch.  If blank, the system will assume that there is no limit.  If the number of cases in the order exceeds this maximum, then the batch balancer's splitting logic will distribute the cases into multiple batches uniformly while honoring certain rules.",
            "type":"number",
            "format":"double"
        },
        "bbIsNewStore":{
            "description":"Indicates if this location should be treated as a new store by the Batch Balancer logic.  New stores can only be assigned by Batch Balancer to a DOOR whose LOAD_NEW_STORE field is set to Y.",
            "type":"boolean"
        },
        "bbOrderSplitMethod":{
            "description":"Value of \"CONVEYABLE\" causes only conveyable cases to be counted toward max cases, value of \"ALL\" causes all cases (including non-con and repack) to count toward max cases.",
            "type":"string"
        },
        "excludeFromRouteExecution":{
            "description":"When = Y, this location is excluded from any Route Instance Legs.",
            "type":"boolean"
        },
        "appointDisplay":{
            "description":"The duration of appointment display time period.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "appointDisplayStartTime":{
            "description":"The start time of appointment view display.",
            "type":"number",
            "format":"int32"
        },
        "pickupRoutingSequenceGid":{
            "description":"Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.",
            "type":"string"
        },
        "dropoffRoutingSequenceGid":{
            "description":"Pickup Routing Sequence and Dropoff Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order.",
            "type":"string"
        },
        "postalSplcGid":{
            "description":"The Postal Standard Point Location Code for this Location.",
            "type":"string"
        },
        "railSplcGid":{
            "description":"The Rail Standard Point Location Code for this Location.",
            "type":"string"
        },
        "railStationCodeGid":{
            "description":"The Rail Station Code for this Location.",
            "type":"string"
        },
        "erpcGid":{
            "description":"The Eastern Region Presidents Commission Code for this Location.",
            "type":"string"
        },
        "railJunctionCodeGid":{
            "description":"The Rail Junction Code for this Location.",
            "type":"string"
        },
        "servingServprovProfileGid":{
            "description":"The Serving Service Provider Profile for this Location.",
            "type":"string"
        },
        "yardRowLabels":{
            "description":"Comma separated list of labels for rows in a yard.",
            "type":"string"
        },
        "yardSlotLabels":{
            "description":"Comma separated list of labels for slots in a yard.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Identifies if the location record is a template or represents a physical location.",
            "type":"boolean"
        },
        "description":{
            "description":"Free text to capture different location types or classifications like customer, vendor site, or stores etc.",
            "type":"string"
        },
        "standingApptCutoffWindow":{
            "description":"The cutoff window by which unbooked standing appointments to be released.",
            "type":"number",
            "format":"int32"
        },
        "allowDriverRest":{
            "description":"Indicates if a driver is allowed to take a rest period at this location if he runs out of available HOS.",
            "type":"boolean"
        },
        "apptObjectType":{
            "description":"Indicates the types of appointment objects this location handles.  Shipments, Shipment Groups or both Shipments and Shipment Groups.",
            "type":"string"
        },
        "apptSearchDays":{
            "description":"Use the Appointment Search Days field to override the value of the glog.appointment.searchDays property for this location. Set this field to control the number of days to look forward for the first feasible appointment.",
            "type":"number",
            "format":"double"
        },
        "apptShowNumberOfOptions":{
            "description":"Use the Appointment Show Number Of Options field to override the value of the glog.appointment.scheduleAppointmentShowOptions.numberOfAppointments property for this location. Set this field to control how many appointments are displayed when running the Schedule Appointment - Show Options action on the Appointment Management page.",
            "type":"number",
            "format":"double"
        },
        "appointmentActivityType":{
            "description":"Appointment activity type refers to whether the appointment if for a drop trailer or live unload scenario.",
            "type":"string"
        },
        "isFixedAddress":{
            "description":"Y/N if address is only allowed to be edited by the UI.",
            "type":"boolean"
        },
        "primaryAddressLineSeq":{
            "description":"The Address Line Number or primary address line sequence number designates which line of the address text box contains the actual street address so when using the External Distance Engine, the correct street address is used. <br>For example, if you had this address in the text box, the line number would be 2.<br>Care of Someone<br>1234 Main St.<br>",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isActive":{
            "description":"Used to activate or deactivate location. When the value is 'N', it can restrain user from planning order to or from the inactive location; from tendering shipment with inactive location.",
            "type":"boolean"
        },
        "addressUpdateDate":{
            "description":"Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "srcArbLevelOfServiceGid":{
            "description":"Preferred source arbitrary level of service when selecting the source arbitrary for a location during bulkplan.",
            "type":"string"
        },
        "destArbLevelOfServiceGid":{
            "description":"Preferred destination arbitrary level of service when selecting the destination arbitrary for a location during bulkplan.",
            "type":"string"
        },
        "useSingleServprovRule":{
            "description":"This specifies the use of single service provider rule at a location. The options are: null - rule is not used, P - for pickups only, D - for deliveries only, B - for both pickups and deliveries.",
            "type":"string"
        },
        "shuttleLotEqGrpProfileGid":{
            "description":"This specifies the equipment group profile for the shuttle or parking lot of a location. When a shipment uses one of the equipment groups in this equipment group profile, the location cannot be directly accessed for pickup/delivery and is accessed only through the shuttle lot. In this case, additional shuttle lot activity time is computed and added to the activity time at the location.",
            "type":"string"
        },
        "isWmsFacility":{
            "description":"Indicates if the location is a warehouse management system facility.",
            "type":"boolean"
        },
        "eruGrouping":{
            "description":"To indicate orders going to this location will be grouped together for ERU grouping.",
            "type":"string"
        },
        "apptEnforceActTimeSg":{
            "description":"Enforce Activity Time for shipment group appointments.",
            "type":"boolean"
        },
        "addressValidationEde":{
            "description":"Indicates which external distance engine is used to validate the location.",
            "type":"string"
        },
        "overallQuality":{
            "description":"Indicates the overall quality of the location.",
            "type":"string"
        },
        "hasMultipleMatches":{
            "description":"Indicates if we have multiple matches for the location after address validation.",
            "type":"string"
        },
        "apptCutoffHours":{
            "description":"Service provider appointment cutoff in hours.",
            "type":"number",
            "format":"double"
        },
        "apptBeforeCutoff":{
            "description":"Service provider appointment duration before cutoff.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "apptAfterCutoff":{
            "description":"Service provider appointment duration after cutoff.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "apptStartTimeToleranceSecs":{
            "description":"Stores tolerance value for appointment start time in seconds.",
            "type":"number",
            "format":"int32"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "resourceGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contacts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.contacts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "operationalLocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.operationalLocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "capacityGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.capacityGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "roleProfiles":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "loadUnloadPoints":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.loadUnloadPoints"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "addresses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.addresses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "resourceTypes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "servprovPrefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.servprovPrefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "substitutes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.substitutes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "corporations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.corporations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : addresses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.addresses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : addressUpdateDate

Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.

Match All

Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.

Show Source

• object dateTimeType

{
    "description":"Date on which the details -CITY,COUNTRY,PROVINCE,PROVINCE_CODE,POSTAL_CODE are modified.RPLS checks this date before it starts screening.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointDisplay

The duration of appointment display time period.

Match All

The duration of appointment display time period.

Show Source

• object amountType

{
    "description":"The duration of appointment display time period.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : apptAfterCutoff

Service provider appointment duration after cutoff.

Match All

Service provider appointment duration after cutoff.

Show Source

• object amountType

{
    "description":"Service provider appointment duration after cutoff.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : apptBeforeCutoff

Service provider appointment duration before cutoff.

Match All

Service provider appointment duration before cutoff.

Show Source

• object amountType

{
    "description":"Service provider appointment duration before cutoff.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : capacityGroups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.capacityGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contacts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.contacts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : corporations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.corporations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : loadUnloadPoints

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.loadUnloadPoints"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : operationalLocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.operationalLocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : resourceGroups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : resourceTypes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : roleProfiles

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : servprovPrefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.servprovPrefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : slotTimeInterval

The smallest appointment slot interval for the location.

Match All

The smallest appointment slot interval for the location.

Show Source

• object amountType

{
    "description":"The smallest appointment slot interval for the location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : substitutes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.substitutes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.accessorials

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.accessorials

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial code for the location.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The GID for the accessorial code for the location.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.addresses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.addresses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.addresses

Type: object

Show Source

• addressLine: string
  Address line data.
• domainName: string
  Database domain where this data is stored.
• lineSequence: number (int64)
  The line sequence number for the address line.
• links: array links
  Read Only: true

{
    "properties":{
        "lineSequence":{
            "description":"The line sequence number for the address line.",
            "type":"number",
            "format":"int64"
        },
        "addressLine":{
            "description":"Address line data.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.capacityGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.capacityGroups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.capacityGroups

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  Effective date for the location capacity group assigned to the location.
• expirationDate: expirationDate
  Expiration date for the location capacity group assigned to the location.
• links: array links
  Read Only: true
• locCapacityGroupGid: string
  The GID for the location capacity group for this location.

{
    "properties":{
        "locCapacityGroupGid":{
            "description":"The GID for the location capacity group for this location.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"Effective date for the location capacity group assigned to the location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"Expiration date for the location capacity group assigned to the location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

Effective date for the location capacity group assigned to the location.

Match All

Effective date for the location capacity group assigned to the location.

Show Source

• object dateTimeType

{
    "description":"Effective date for the location capacity group assigned to the location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : expirationDate

Expiration date for the location capacity group assigned to the location.

Match All

Expiration date for the location capacity group assigned to the location.

Show Source

• object dateTimeType

{
    "description":"Expiration date for the location capacity group assigned to the location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.contacts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.contacts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.contacts

Type: object

Show Source

• alternateName: string
  If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.
  Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• cellPhone: string
  Contains the mobile/cell phone number for the location's contact person. Do not include special characters such as "+" and "-".
• comMethods: comMethods
• companyName: string
  Company name for this party.
• consolidatedNotifyOnly: boolean
  Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.
• consolidationProfileGid: string
  The GID for the consolidation profile. You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.
• contactGid: string
  The GID for the contact for the location.
• contactPreferences: contactPreferences
• contactType: string
  Defines whether a contact is a person or group.
• contactXid: string
  The XID for the contact for the location.
• description: string
  Enter any additional descriptive information for this party/contact.
• domainName: string
  Database domain where this data is stored.
• ecmUser: string
  If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.
• emailAddress: string
  The email address of the contact person for the location.
• externalSystemGid: string
  The external system GID.
• fax: string
  The facsimile number for the contact person for the location.
• firstName: string
  The given name of the contact person for the location.
• fromAddrContact: fromAddrContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• fromAddrContactGid: string
  The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• glUserGid: string
  The GL user GID.
• groupSavedQueryGid: string
  Valid only if the contact_type = 'GROUP'. The saved_query could then define which individual contacts belong to the contact_group.
• indicator: string
  Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
• ippPrinterGid: string
  Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.
• isBroadcast: boolean
  Valid only if the contact_type = 'GROUP'. This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.
• isEmailVirusProtected: boolean
  If Y, document attachments may be sent to the contact without virus checking.
• isFromAddress: boolean
  Indicates if a contact is a 'From-Address' contact.
• isNotificationOn: boolean
  No notification will be sent to the contact if this field is set to false ('N').
• isPrimaryContact: boolean
  Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N). This attribute is marked as Create-Only.
• jobTitle: string
  The title for the contact person at the location.
• languageSpoken: string
  The language the contact person at the location speaks.
• lastName: string
  The surname of the contact person for the location.
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  The GID for the location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• messageProfileGid: string
  The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.
• middleName: string
  The middle name of the contact.
• nameAddressUpdateDate: nameAddressUpdateDate
  Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.
• notes: string
  Text describing something regarding the contact person for the location or the location itself.
• phone1: string
  The primary telephone number for the location's contact person.
• phone2: string
  The secondary telephone number for the location's contact person.
• recipientDomainName: string
  The domain of a message recipient.
• routeThroughLocation: boolean
  Indicates if the notification should use location.
• sendAsMessage: boolean
  Indicates that messages should be sent to message center.
• telex: string
  The telephone number for telex communications for the location's contact person.
• timeZoneGid: string
  Time zone for the contact.
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.

{
    "properties":{
        "contactGid":{
            "description":"The GID for the contact for the location.",
            "type":"string"
        },
        "contactXid":{
            "description":"The XID for the contact for the location.",
            "type":"string"
        },
        "firstName":{
            "description":"The given name of the contact person for the location.",
            "type":"string"
        },
        "lastName":{
            "description":"The surname of the contact person for the location.",
            "type":"string"
        },
        "jobTitle":{
            "description":"The title for the contact person at the location.",
            "type":"string"
        },
        "emailAddress":{
            "description":"The email address of the contact person for the location.",
            "type":"string"
        },
        "phone1":{
            "description":"The primary telephone number for the location's contact person.",
            "type":"string"
        },
        "phone2":{
            "description":"The secondary telephone number for the location's contact person.",
            "type":"string"
        },
        "fax":{
            "description":"The facsimile number for the contact person for the location.",
            "type":"string"
        },
        "languageSpoken":{
            "description":"The language the contact person at the location speaks.",
            "type":"string"
        },
        "isPrimaryContact":{
            "description":"Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N). This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "telex":{
            "description":"The telephone number for telex communications for the location's contact person.",
            "type":"string"
        },
        "externalSystemGid":{
            "description":"The external system GID.",
            "type":"string"
        },
        "notes":{
            "description":"Text describing something regarding the contact person for the location or the location itself.",
            "type":"string"
        },
        "glUserGid":{
            "description":"The GL user GID.",
            "type":"string"
        },
        "recipientDomainName":{
            "description":"The domain of a message recipient.",
            "type":"string"
        },
        "routeThroughLocation":{
            "description":"Indicates if the notification should use location.",
            "type":"boolean"
        },
        "contactType":{
            "description":"Defines whether a contact is a person or group.",
            "type":"string"
        },
        "isBroadcast":{
            "description":"Valid only if the contact_type = 'GROUP'.  This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.",
            "type":"boolean"
        },
        "groupSavedQueryGid":{
            "description":"Valid only if the contact_type = 'GROUP'.  The saved_query could then define which individual contacts belong to the contact_group.",
            "type":"string"
        },
        "locationGid":{
            "description":"The GID for the location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "isEmailVirusProtected":{
            "description":"If Y, document attachments may be sent to the contact without virus checking.",
            "type":"boolean"
        },
        "consolidationProfileGid":{
            "description":"The GID for the consolidation profile.  You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.",
            "type":"string"
        },
        "consolidatedNotifyOnly":{
            "description":"Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.",
            "type":"boolean"
        },
        "isNotificationOn":{
            "description":"No notification will be sent to the contact if this field is set to false ('N').",
            "type":"boolean"
        },
        "timeZoneGid":{
            "description":"Time zone for the contact.",
            "type":"string"
        },
        "fromAddrContactGid":{
            "description":"The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "fromAddrContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "isFromAddress":{
            "description":"Indicates if a contact is a 'From-Address' contact.",
            "type":"boolean"
        },
        "middleName":{
            "description":"The middle name of the contact.",
            "type":"string"
        },
        "cellPhone":{
            "description":"Contains the mobile/cell  phone number for the location's contact person.  Do not include special characters such as \"+\" and \"-\".",
            "type":"string"
        },
        "sendAsMessage":{
            "description":"Indicates that messages should be sent to message center.",
            "type":"boolean"
        },
        "messageProfileGid":{
            "description":"The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "alternateName":{
            "description":"If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.<br>Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name for this party.",
            "type":"string"
        },
        "description":{
            "description":"Enter any additional descriptive information for this party/contact.",
            "type":"string"
        },
        "ippPrinterGid":{
            "description":"Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.",
            "type":"string"
        },
        "ecmUser":{
            "description":"If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "nameAddressUpdateDate":{
            "description":"Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "indicator":{
            "description":"Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "comMethods":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.contacts.comMethods"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contactPreferences":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.contacts.contactPreferences"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : comMethods

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.contacts.comMethods"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contactPreferences

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.contacts.contactPreferences"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : fromAddrContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : nameAddressUpdateDate

Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.

Match All

Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.

Show Source

• object dateTimeType

{
    "description":"Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.contacts.comMethods

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.contacts.comMethods"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.contacts.comMethods

Type: object

Show Source

• calendarGid: string
  The calendar GID.
• comMethodGid: string
  The communication method GID.
• comMethodRank: number (int32)
  A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.
• domainName: string
  Database domain where this data is stored.
• expectedResponseTime: expectedResponseTime
  This value is used when the location represents the service provider. It specifies the response time for a shipment tender.
• links: array links
  Read Only: true

{
    "properties":{
        "comMethodRank":{
            "description":"A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.",
            "type":"number",
            "format":"int32"
        },
        "comMethodGid":{
            "description":"The communication method GID.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID.",
            "type":"string"
        },
        "expectedResponseTime":{
            "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : expectedResponseTime

This value is used when the location represents the service provider. It specifies the response time for a shipment tender.

Match All

This value is used when the location represents the service provider. It specifies the response time for a shipment tender.

Show Source

• object amountType

{
    "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.contacts.contactPreferences

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.contacts.contactPreferences"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.contacts.contactPreferences

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• preferenceGid: string
  The preference GID.
• value: string
  The value or Rank for the communication method. The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.

{
    "properties":{
        "preferenceGid":{
            "description":"The preference GID.",
            "type":"string"
        },
        "value":{
            "description":"The value or Rank for the communication method.  The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• alternateName: string
  If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.
  Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• cellPhone: string
  Contains the mobile/cell phone number for the location's contact person. Do not include special characters such as "+" and "-".
• comMethods: comMethods
• companyName: string
  Company name for this party.
• consolidatedNotifyOnly: boolean
  Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.
• consolidationProfileGid: string
  The GID for the consolidation profile. You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.
• contactGid: string
  The GID for the contact for the location.
• contactType: string
  Defines whether a contact is a person or group.
• contactXid: string
  The XID for the contact for the location.
• corporations: corporations
• description: string
  Enter any additional descriptive information for this party/contact.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• ecmUser: string
  If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.
• emailAddress: string
  The email address of the contact person for the location.
• externalSystemGid: string
  The external system GID.
• fax: string
  The facsimile number for the contact person for the location.
• firstName: string
  The given name of the contact person for the location.
• fromAddrContact: fromAddrContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• fromAddrContactGid: string
  The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• glUserGid: string
  The GL user GID.
• groups: groups
• groupSavedQueryGid: string
  Valid only if the contact_type = 'GROUP'. The saved_query could then define which individual contacts belong to the contact_group.
• indicator: string
  Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• ippPrinterGid: string
  Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.
• isBroadcast: boolean
  Valid only if the contact_type = 'GROUP'. This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.
• isEmailVirusProtected: boolean
  If Y, document attachments may be sent to the contact without virus checking.
• isFromAddress: boolean
  Indicates if a contact is a 'From-Address' contact.
• isNotificationOn: boolean
  No notification will be sent to the contact if this field is set to false ('N').
• isPrimaryContact: boolean
  Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N).
• jobTitle: string
  The title for the contact person at the location.
• languageSpoken: string
  The language the contact person at the location speaks.
• lastName: string
  The surname of the contact person for the location.
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  The GID for the location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• messageProfileGid: string
  The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.
• middleName: string
  The middle name of the contact.
• nameAddressUpdateDate: nameAddressUpdateDate
  Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.
• notes: string
  Text describing something regarding the contact person for the location or the location itself.
• partyCodes: partyCodes
• partyScreenings: partyScreenings
• phone1: string
  The primary telephone number for the location's contact person.
• phone2: string
  The secondary telephone number for the location's contact person.
• preferences: preferences
• recipientDomainName: string
  The domain of a message recipient.
• refnums: refnums
• remarks: remarks
• routeThroughLocation: boolean
  Indicates if the notification should use location.
• sanctionedScreenings: sanctionedScreenings
• sendAsMessage: boolean
  Indicates that messages should be sent to message center.
• statuses: statuses
• telex: string
  The telephone number for telex communications for the location's contact person.
• timeZoneGid: string
  Time zone for the contact.
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.

{
    "properties":{
        "contactGid":{
            "description":"The GID for the contact for the location.",
            "type":"string"
        },
        "contactXid":{
            "description":"The XID for the contact for the location.",
            "type":"string"
        },
        "firstName":{
            "description":"The given name of the contact person for the location.",
            "type":"string"
        },
        "lastName":{
            "description":"The surname of the contact person for the location.",
            "type":"string"
        },
        "jobTitle":{
            "description":"The title for the contact person at the location.",
            "type":"string"
        },
        "emailAddress":{
            "description":"The email address of the contact person for the location.",
            "type":"string"
        },
        "phone1":{
            "description":"The primary telephone number for the location's contact person.",
            "type":"string"
        },
        "phone2":{
            "description":"The secondary telephone number for the location's contact person.",
            "type":"string"
        },
        "fax":{
            "description":"The facsimile number for the contact person for the location.",
            "type":"string"
        },
        "languageSpoken":{
            "description":"The language the contact person at the location speaks.",
            "type":"string"
        },
        "isPrimaryContact":{
            "description":"Indicates if this contact person at the location is the primary contact person (if so Y) or not (if not N).",
            "type":"boolean"
        },
        "telex":{
            "description":"The telephone number for telex communications for the location's contact person.",
            "type":"string"
        },
        "externalSystemGid":{
            "description":"The external system GID.",
            "type":"string"
        },
        "notes":{
            "description":"Text describing something regarding the contact person for the location or the location itself.",
            "type":"string"
        },
        "glUserGid":{
            "description":"The GL user GID.",
            "type":"string"
        },
        "recipientDomainName":{
            "description":"The domain of a message recipient.",
            "type":"string"
        },
        "routeThroughLocation":{
            "description":"Indicates if the notification should use location.",
            "type":"boolean"
        },
        "contactType":{
            "description":"Defines whether a contact is a person or group.",
            "type":"string"
        },
        "isBroadcast":{
            "description":"Valid only if the contact_type = 'GROUP'.  This is a Boolean flag which controls whether GC3 creates a single notification message and broadcasts (i.e. cc) it to each group member or whether GC3 creates a message customized for each member.",
            "type":"boolean"
        },
        "groupSavedQueryGid":{
            "description":"Valid only if the contact_type = 'GROUP'.  The saved_query could then define which individual contacts belong to the contact_group.",
            "type":"string"
        },
        "locationGid":{
            "description":"The GID for the location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "isEmailVirusProtected":{
            "description":"If Y, document attachments may be sent to the contact without virus checking.",
            "type":"boolean"
        },
        "consolidationProfileGid":{
            "description":"The GID for the consolidation profile.  You would enter a Consolidation Profile if you are using consolidated notification. If a consolidation profile is entered, it will apply to all contact notifications that do not have a consolidated notification profile.",
            "type":"string"
        },
        "consolidatedNotifyOnly":{
            "description":"Select the Consolidated Notify Only check box if the only notification sent is to be consolidated and the communication method is email, fax or message center.",
            "type":"boolean"
        },
        "isNotificationOn":{
            "description":"No notification will be sent to the contact if this field is set to false ('N').",
            "type":"boolean"
        },
        "timeZoneGid":{
            "description":"Time zone for the contact.",
            "type":"string"
        },
        "fromAddrContactGid":{
            "description":"The GID that contains a contact's 'From-Address' details. Valid only if IS_FROM_ADDRESS is 'N'. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "fromAddrContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "isFromAddress":{
            "description":"Indicates if a contact is a 'From-Address' contact.",
            "type":"boolean"
        },
        "middleName":{
            "description":"The middle name of the contact.",
            "type":"string"
        },
        "cellPhone":{
            "description":"Contains the mobile/cell  phone number for the location's contact person.  Do not include special characters such as \"+\" and \"-\".",
            "type":"string"
        },
        "sendAsMessage":{
            "description":"Indicates that messages should be sent to message center.",
            "type":"boolean"
        },
        "messageProfileGid":{
            "description":"The GID for the message profile. A message profile provides a grouping of stylesheet profiles for inbound message processing. It represents the different formats a device can send to the system. A message profile is assigned to a contact. If the message type for an incoming message, the system attempts to apply the stylesheet profiles listed in the message profile. They are applied to the incoming message in the order of the Attempt Sequence of the message profile.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "alternateName":{
            "description":"If the contact goes by an alternate name the alternate name should be entered here. For example, real name Laurence Tureaud, alternate name Mr. T.<br>Note: GTM bases restricted party screening on the party's company name. If the contact has an alternate name, the contact's alternate name is screened instead.",
            "type":"string"
        },
        "companyName":{
            "description":"Company name for this party.",
            "type":"string"
        },
        "description":{
            "description":"Enter any additional descriptive information for this party/contact.",
            "type":"string"
        },
        "ippPrinterGid":{
            "description":"Used to assign an IPP printer as a recipient of notifications, particularly of document or report events.",
            "type":"string"
        },
        "ecmUser":{
            "description":"If the contact is acting as a reviewer or subscriber to documents within Oracle ECM, the ECM user mapping to the contact.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "nameAddressUpdateDate":{
            "description":"Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "indicator":{
            "description":"Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "comMethods":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.comMethods"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "sanctionedScreenings":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.sanctionedScreenings"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "partyCodes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.partyCodes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "corporations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.corporations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "preferences":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.preferences"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "groups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.groups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "partyScreenings":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.partyScreenings"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : comMethods

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.comMethods"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : corporations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.corporations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : fromAddrContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fromAddrContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : groups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.groups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : nameAddressUpdateDate

Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.

Match All

Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.

Show Source

• object dateTimeType

{
    "description":"Date on which the details - FIRST_NAME,LAST_NAME,COMPANY_NAME,ALTERNATE_NAME,LOCATION_GID are modified.RPLS checks this date before it starts screening.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : partyCodes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.partyCodes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : partyScreenings

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.partyScreenings"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : preferences

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.preferences"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sanctionedScreenings

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.sanctionedScreenings"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.comMethods"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• calendarGid: string
  The calendar GID.
• comMethodGid: string
  The communication method GID.
• comMethodRank: number (int32)
  A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.
• domainName: string
  Database domain where this data is stored.
• expectedResponseTime: expectedResponseTime
  This value is used when the location represents the service provider. It specifies the response time for a shipment tender.
• links: array links
  Read Only: true

{
    "properties":{
        "comMethodRank":{
            "description":"A numeric value to rank the communication methods at the location. For example a location may have E-Mail, Fax and Phone as preferred communication methods in that rank.",
            "type":"number",
            "format":"int32"
        },
        "comMethodGid":{
            "description":"The communication method GID.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID.",
            "type":"string"
        },
        "expectedResponseTime":{
            "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : expectedResponseTime

This value is used when the location represents the service provider. It specifies the response time for a shipment tender.

Match All

This value is used when the location represents the service provider. It specifies the response time for a shipment tender.

Show Source

• object amountType

{
    "description":"This value is used when the location represents  the service provider. It specifies the response time for a shipment tender.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.corporations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• corporation: corporation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• corporationGid: string
  The GID for the corporation related to the contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "corporationGid":{
            "description":"The GID for the corporation related to the contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "corporation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/corporations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : corporation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/corporations"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• corporationGid: string
  Contains the GID for the corporation.
• corporationName: string
  Contains the name of the corporation.
• corporationXid: string
  Contains the XID for the corporation.
• domainName: string
  Database domain where this data is stored.
• dropoffRoutingSequenceGid: string
  The GID for the dropoff routing sequence. The Dropoff Routing Sequence controls the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isAllowHouseCollect: boolean
  The Allow House Collect check box field is used to indicate whether or not a shipping agent is allowed to handle shipments with COLLECT payment terms. Note: This check box is used for visibility and is not currently enforced within the base application i.e., this is for information only.
• isDomainMaster: boolean
  Check box field to identify a corporation record as the domain master. The domain master corporation determines the default involved parties for an order, given the domain of the order. When a shipment is built, it grabs the LOGISTICS involved party from the master corporation for the domain and adds it to the shipment. It also does the same for the order for BILL-TO, LOGISTICS, ORDEROWNER, ORDERSUPPLIER, SHIPPER, CONSIGNEE when the order is created. Also, when trying to get the primary contact for a shipment tender, Oracle Transportation Management looks for a contact that is associated to the master corporation for the domain and the service provider.
• isShippingAgentsActive: boolean
  Indicates if corporation is active. Used with agents.
• links: array links
  Read Only: true
• maxHouseCollectAmt: maxHouseCollectAmt
  If house collection is allowed, the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.
• pickupRoutingSequenceGid: string
  The GID for the pickup routing sequence. The Pickup Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.
• updateDate: updateDate
  Read Only: true

  update date
• vatProvincialRegistrations: vatProvincialRegistrations
• vatRegistrations: vatRegistrations

{
    "properties":{
        "corporationGid":{
            "description":"Contains the GID for the corporation.",
            "type":"string"
        },
        "corporationXid":{
            "description":"Contains the XID for the corporation.",
            "type":"string"
        },
        "corporationName":{
            "description":"Contains the name of the corporation.",
            "type":"string"
        },
        "isDomainMaster":{
            "description":"Check box field to identify a corporation record as the domain master.  The domain master corporation determines the default involved parties for an order, given the domain of the order. When a shipment is built, it grabs the LOGISTICS involved party from the master corporation for the domain and adds it to the shipment. It also does the same for the order for BILL-TO, LOGISTICS, ORDEROWNER, ORDERSUPPLIER, SHIPPER, CONSIGNEE when the order is created. Also, when trying to get the primary contact for a shipment tender, Oracle Transportation Management looks for a contact that is associated to the master corporation for the domain and the service provider.",
            "type":"boolean"
        },
        "isShippingAgentsActive":{
            "description":"Indicates if corporation is active. Used with agents.",
            "type":"boolean"
        },
        "isAllowHouseCollect":{
            "description":"The Allow House Collect check box field is used to indicate whether or not a shipping agent is allowed to handle shipments with COLLECT payment terms.  Note: This check box is used for visibility and is not currently enforced within the base application i.e., this is for information only.",
            "type":"boolean"
        },
        "maxHouseCollectAmt":{
            "description":"If house collection is allowed,  the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pickupRoutingSequenceGid":{
            "description":"The GID for the pickup routing sequence. The Pickup Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.",
            "type":"string"
        },
        "dropoffRoutingSequenceGid":{
            "description":"The GID for the dropoff routing sequence. The Dropoff Routing Sequence controls the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "vatProvincialRegistrations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.vatProvincialRegistrations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vatRegistrations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.vatRegistrations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/corporations.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxHouseCollectAmt

If house collection is allowed, the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.

Match All

If house collection is allowed, the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.

Show Source

• object currencyType

{
    "description":"If house collection is allowed,  the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : vatProvincialRegistrations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/corporations.vatProvincialRegistrations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : vatRegistrations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/corporations.vatRegistrations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/corporations.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The GID for the communication method.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• involvedPartyQualGid: string
  The GID for the involved party qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The GID for the contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The GID for the communication method.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/corporations.vatProvincialRegistrations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• countryCode3Gid: string
  The country code for the provincial VAT registration.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• provinceCode: string
  The province code of the registration.
• vatProvincialRegGid: string
  The provincial VAT registration ID.
• vatProvincialRegXid: string
  The XID for the provincial VAT registration.

{
    "properties":{
        "vatProvincialRegGid":{
            "description":"The provincial VAT registration ID.",
            "type":"string"
        },
        "vatProvincialRegXid":{
            "description":"The XID for the provincial VAT registration.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code for the provincial VAT registration.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code of the registration.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/corporations.vatRegistrations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• vatRegNoGid: string
  VAT registration linked to the corporation indicated by the corporation GID.

{
    "properties":{
        "vatRegNoGid":{
            "description":"VAT registration linked to the corporation indicated by the corporation GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tradeParties.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tradeParties.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

• cmsParams: cmsParams
• contentManagementSystemGid: string
  No description.
• contents: contents
• contexts: contexts
• documentCmsId: string
  Read Only: true

  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description. This attribute is marked as Create-Only.
• documentTrackingNum: string
  No description.
• documentType: string
  Read Only: true

  No description.
• documentUrl: string
  Read Only: true

  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• ownerObjectGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• statuses: statuses
• updateDate: updateDate
  Read Only: true

  update date
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string",
            "readOnly":true
        },
        "documentType":{
            "description":"No description.",
            "type":"string",
            "readOnly":true
        },
        "documentMimeType":{
            "description":"No description. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "ownerObjectGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string",
            "readOnly":true
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "contexts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.contexts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "cmsParams":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.cmsParams"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.contents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cmsParams

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents.cmsParams"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents.contents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contexts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents.contexts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object documents.cmsParams

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents.cmsParams"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : documents.cmsParams

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• paramName: string
  Parameter name
• paramValue: string
  Parameter value

{
    "properties":{
        "paramName":{
            "description":"Parameter name",
            "type":"string"
        },
        "paramValue":{
            "description":"Parameter value",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object documents.contents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents.contents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : documents.contents

Type: object

Show Source

• documentContentGid: string
  NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "documentContentGid":{
            "description":"NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object documents.contexts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents.contexts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : documents.contexts

Type: object

Show Source

• documentContextQualGid: string
  Represents the document context qualifier.
• documentContextValue: string
  Represents the value of a document context qualifier.
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "documentContextQualGid":{
            "description":"Represents the document context qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "documentContextValue":{
            "description":"Represents the value of a document context qualifier.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object documents.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : documents.statuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  No description.
• statusValueGid: string
  No description.

{
    "properties":{
        "statusTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.groups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The contact GID references a person contact which will inherit notifications, etc. from it's contact group. A contact may belong to more than one contact group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The contact GID references a person contact which will inherit notifications, etc. from it's contact group.  A contact may belong to more than one contact group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The GID for the communication method.
• domainName: string
  Database domain where this data is stored.
• gtmRegistrationGid: string
  The GID for the registration being assigned to the party.
• involvedPartyQualGid: string
  The GID for the involved party qualifier related to the registration.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmRegistrationGid":{
            "description":"The GID for the registration being assigned to the party.",
            "type":"string"
        },
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier related to the registration.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The GID for the communication method.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.partyCodes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmCode: string
  The code is related to the type which is related to the user defined party classification.
• gtmTypeGid: string
  The GID for the type related to the user defined party classification.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmTypeGid":{
            "description":"The GID for the type related to the user defined party classification.",
            "type":"string"
        },
        "gtmCode":{
            "description":"The code is related to the type which is related to the user defined party classification.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.partyScreenings"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• approvedBy: string
  Approver for matches requiring review.
• domainName: string
  Database domain where this data is stored.
• gtmDeniedPartyGid: string
  The GID for the denied party.
• gtmServicePrefGid: string
  The unique GID for the service preference used for screening.
• links: array links
  Read Only: true
• matchFactor: number (int32)
  Match factor is determined by GTM and represents the match factor (matching percentage) between the party and the restricted party.
• partyScreeningComments: partyScreeningComments
• partyScreeningSequence: number (int64)
  Sequence number for potential matches.
• screeningStatus: string
  Denied party to party screening status. Potential Match -Some similarities exist between the restricted party list and the contact being screened. Verified Match - The contact being screened matches a name on the restricted party list and the match has been verified by a user. Not a Match
  - No similarity exists between the restricted party list and the contact being screened. Escalated -
  The potential match was referred to another person for review.

{
    "properties":{
        "partyScreeningSequence":{
            "description":"Sequence number for potential matches.",
            "type":"number",
            "format":"int64"
        },
        "gtmDeniedPartyGid":{
            "description":"The GID for the denied party.",
            "type":"string"
        },
        "screeningStatus":{
            "description":"Denied party to party screening status. Potential Match -Some similarities exist between the restricted party list and the contact being screened.  Verified Match - The contact being screened matches a name on the restricted party list and the match has been verified by a user.  Not a Match<br> - No similarity exists between the restricted party list and the contact being screened.  Escalated -<br>The potential match was referred to another person for review.",
            "type":"string"
        },
        "approvedBy":{
            "description":"Approver for matches requiring review.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "matchFactor":{
            "description":"Match factor is determined by GTM and represents the match factor (matching percentage) between the party and the restricted party.",
            "type":"number",
            "format":"int32"
        },
        "gtmServicePrefGid":{
            "description":"The unique GID for the service preference used for screening.",
            "type":"string"
        },
        "partyScreeningComments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : partyScreeningComments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.partyScreenings.partyScreeningComments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• commentBy: string
  User entering the comment.
• commentText: string
  Text related to comment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• partyCommentSequence: number (int64)
  Sequence number for potential matches comment.

{
    "properties":{
        "partyCommentSequence":{
            "description":"Sequence number for potential matches comment.",
            "type":"number",
            "format":"int64"
        },
        "commentText":{
            "description":"Text related to comment.",
            "type":"string"
        },
        "commentBy":{
            "description":"User entering the comment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.preferences"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• preferenceGid: string
  The preference GID.
• value: string
  The value or Rank for the communication method. The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.

{
    "properties":{
        "preferenceGid":{
            "description":"The preference GID.",
            "type":"string"
        },
        "value":{
            "description":"The value or Rank for the communication method.  The value (Rank) prioritizes the saved communication methods. The highest priority is 1. If the rank between two companies does not match, the method preferred by the source company (shipper) is used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• gtmPartyRefnumQualGid: string
  The GID for the party reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The value for the reference number.

{
    "properties":{
        "gtmPartyRefnumQualGid":{
            "description":"The GID for the party reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The value for the reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The unique GID for the remark qualifier.
• remarkSeqNo: number (int64)
  Sequence number for remark. Not visible in the UI.
• remarkText: string
  Remark text.

{
    "properties":{
        "remarkSeqNo":{
            "description":"Sequence number for remark. Not visible in the UI.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The unique GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.sanctionedScreenings"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• complianceRuleGid: string
  The GID for the GTM compliance rule. You can configure screening to fit any combination of rules or policies that you deem to be necessary. Compliance rules can be added to a rule set, rule sets can be added to rule set groups, and rule set groups can be combined into a compliance policy which is then used in transaction screening.
• complianceRuleGroupGid: string
  The GID for the GTM compliance rule group. The compliance rule group is considered an optional input for sanctioned territory screening. If no compliance rule group is provided, the service preference given in user preference is considered for getting compliance rule group information. If a user preference has not been designated, screening will be done against all sanction rules using the Cumulative algorithm.
• controlCode: string
  The control type and control code are linked to the compliance rule.
• controlTypeGid: string
  The GID for the GTM control type. The control type is linked to the compliance rule.
• domainName: string
  Database domain where this data is stored.
• gtmContactStScreenGid: string
  The GID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.
• gtmContactStScreenXid: string
  The XID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.
• links: array links
  Read Only: true
• regulationReferenceGid: string
  The GID for the GTM regulation reference. The regulation reference is related directly to a compliance rule.

{
    "properties":{
        "gtmContactStScreenGid":{
            "description":"The GID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "controlTypeGid":{
            "description":"The GID for the GTM control type. The control type is linked to the compliance rule.",
            "type":"string"
        },
        "controlCode":{
            "description":"The control type and control code are linked to the compliance rule.",
            "type":"string"
        },
        "regulationReferenceGid":{
            "description":"The GID for the GTM regulation reference. The regulation reference is related directly to a compliance rule.",
            "type":"string"
        },
        "gtmContactStScreenXid":{
            "description":"The XID for the GTM sanctioned territory screening. If sanctioned territory screening has taken place via either Trade Compliance Screening or the Sanctioned Territory Screening action, the results will be stored here.",
            "type":"string"
        },
        "complianceRuleGroupGid":{
            "description":"The GID for the GTM compliance rule group. The compliance rule group is considered an optional input for sanctioned territory screening. If no compliance rule group is provided, the service preference given in user preference is considered for getting compliance rule group information. If a user preference has not been designated, screening will be done against all sanction rules using the Cumulative algorithm.",
            "type":"string"
        },
        "complianceRuleGid":{
            "description":"The GID for the GTM compliance rule. You can configure screening to fit any combination of rules or policies that you deem to be necessary. Compliance rules can be added to a rule set, rule sets can be added to rule set groups, and rule set groups can be combined into a compliance policy which is then used in transaction screening.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tradeParties.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  Status type for the contact status.
• statusValueGid: string
  Value of status type.

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the contact status.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.corporations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.corporations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.corporations

Type: object

Show Source

• corporation: corporation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• corporationGid: string
  CORPORATION_GID contains the unique identifier for the location's corporation.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "corporationGid":{
            "description":"CORPORATION_GID contains the unique identifier for the location's corporation. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "corporation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/corporations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : corporation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/corporations"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.loadUnloadPoints

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.loadUnloadPoints"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.loadUnloadPoints

Type: object

Show Source

• description: string
  Description for the load/unload point.
• domainName: string
  Database domain where this data is stored.
• equipmentGroupProfileGid: string
  Equipment group profile for the load/unload point; overrides any at the location.
• isLoad: boolean
  Indicates if this dock or point make be used for loading.
• isUnload: boolean
  Indicates if this dock or point make be used for loading.
• links: array links
  Read Only: true
• loadSequence: number (int32)
  Indicates where dock should be in a load sequence.
• loadUnloadPoint: string
  Load/unload point such as a loading dock.
• unloadSequence: number (int32)
  Indicates where dock should be in an unload sequence.

{
    "properties":{
        "loadUnloadPoint":{
            "description":"Load/unload point such as a loading dock.",
            "type":"string"
        },
        "description":{
            "description":"Description for the load/unload point.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"Equipment group profile for the load/unload point; overrides any at the location.",
            "type":"string"
        },
        "isLoad":{
            "description":"Indicates if this dock or point make be used for loading.",
            "type":"boolean"
        },
        "loadSequence":{
            "description":"Indicates where dock should be in a load sequence.",
            "type":"number",
            "format":"int32"
        },
        "isUnload":{
            "description":"Indicates if this dock or point make be used for loading.",
            "type":"boolean"
        },
        "unloadSequence":{
            "description":"Indicates where dock should be in an unload sequence.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.operationalLocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.operationalLocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.operationalLocations

Type: object

Show Source

• details: details
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• operationalLocation: operationalLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• operationalLocationGid: string
  Sub location belonging to a main location. Sub location may only belong to one location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "operationalLocationGid":{
            "description":"Sub location belonging to a main location. Sub location may only belong to one location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "operationalLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.operationalLocations.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.operationalLocations.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : operationalLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property operationalLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.operationalLocations.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.operationalLocations.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.operationalLocations.details

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• exclusionRegionGid: string
  If set, this operational location is not applicable when the opposite endpoint of the shipment is within the region.
• inboundOutboundType: string
  Indicates whether this operational location for the mapping of the service provider and location profile is used for importing (I), exporting (E), or both (B).
• inclusionRegionGid: string
  If set, this operational location is applicable only when the opposite endpoint of the shipment is within the region.
• links: array links
  Read Only: true
• primaryLegLocProfileGid: string
  The location on the main leg which will help indicate which operational location applies; usually Port of Exit or Port of Discharge.
• primaryLegServprov: primaryLegServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• primaryLegServprovGid: string
  The service provider of the main leg which will help indicate which operational location applies.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• seqNo: number (int64)
  Sequence to allow multiple data records for the same operational location.

{
    "properties":{
        "seqNo":{
            "description":"Sequence to allow multiple data records for the same operational location.",
            "type":"number",
            "format":"int64"
        },
        "primaryLegServprovGid":{
            "description":"The service provider of the main leg which will help indicate which operational location applies. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "primaryLegServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "primaryLegLocProfileGid":{
            "description":"The location on the main leg which will help indicate which operational location applies; usually Port of Exit or Port of Discharge.",
            "type":"string"
        },
        "inboundOutboundType":{
            "description":"Indicates whether this operational location for the mapping of the service provider and location profile is used for importing (I), exporting (E), or both (B).",
            "type":"string"
        },
        "inclusionRegionGid":{
            "description":"If set, this operational location is applicable only when the opposite endpoint of the shipment is within the region.",
            "type":"string"
        },
        "exclusionRegionGid":{
            "description":"If set, this operational location is not applicable when the opposite endpoint of the shipment is within the region.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : primaryLegServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• aliases: aliases
• allocationRuleProfileGid: string
  The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.
• allowSgTender: boolean
  Ship group allow tender determines whether the system can automatically tender ship group to this service provider.By default it is set to 'N'
• allowSpotRating: boolean
  Flag to indicate that service provider is valid for Spot Rating actions
• allowTender: boolean
  Allow Tender determines whether the system can automatically tender (ordinary tender as opposed to Broadcast or Spot Bid tenders mentioned below) shipments to this service provider. Clear the check box to prevent the system from automatically tendering shipments to this service provider. If you have not loaded any rates into the system but still want to be able to create shipments, you may want to set up a dummy service provider with this check box cleared. You must mark this check box if you also plan to configure Broadcast/Spot Bid tendering for the service provider.
  Note: Setting up a service provider's tender timeout requirements is done via the Contact Manager Notification Tab.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• autoApproveRuleProfileGid: string
  The GID for the auto approve rule profile.
• autoPaymentFlag: boolean
  Mark Autopay to have Oracle Transportation Management automatically create an invoice with every shipment for this service provider. Clear the check box, if you want to generate invoices manually in Settlement instead.
• broadcastSpotContact: broadcastSpotContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• broadcastSpotContactGid: string
  Overrides the shipper's primary contact to be used to determine localization preferences for tender notification.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• doConditionalAccepts: boolean
  Determines if the service provider can participate in conditional booking.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• epaIndexValue: number (double)
  If the provider participates in the EPA Smartway program, record it's SIF in the EPA Smartway SIF field.
• equipmentMarkListGid: string
  The Equipment Mark List for this Service Provider.
• incumbent: boolean
  Select the Incumbent check box to indicate that this service provider has been used previously.
• insertDate: insertDate
  Read Only: true

  insert date
• invoicingProcess: string
  The Invoicing Process drop-down list box determines what type of invoice will be generated for shipments from this carrier. If it is set to Standard, then regular invoices will be generated. If you set it to BOL Back, then a BOL Back will be generated. BOL backs are often used for ocean shipments.
• isAcceptBroadcastTenders: boolean
  Is set to Y(es) if the service provider will participate in broadcast tendering.
• isAcceptBySsuAllowed: boolean
  Mark the Allow Accept By Ship Unit check box to let a service provider partially accept a tender by its shipment's Transport Handling Units. Allowing a service provider to partially accept a tender gives service providers a role on the planning process. A new shipment and tender are created based off the amount the Service provider accepts. The original tender (minus the partially accepted units) is still available for future tendering.
• isAcceptSpotBids: boolean
  Is set to Y(es) if the service provider will participate in spot bid tendering.
• isActive: boolean
  This flag will define whether service provider is active or not.By default this flag will be Y.
• isCopyInvDeltaBackToShip: boolean
  The Copy Invoice Delta to Shipment check box indicates whether differences between the approved amount and the amount on the actual invoice should be copied to the shipment. So for example, the shipment was $100, and the invoice was $100, but only $80 was approved and this check box was selected. Then the change, or delta, of $20 will be added to the shipment as an extra adjustment charge. This is not supported when the parent/consolidated invoice is approved by total.
• isDispatchByRegion: boolean
  A flag to turn on/off the Tender by Locale feature.
• isFleet: boolean
  Only shipments created for fleet service providers can perform fleet related actions.
• isInternalNvocc: boolean
  The Internal NVOCC check box identifies whether the service provider acts as an NVOCC (Non-Vessel Operating Common Carrier). If this check box is marked, you can use the Book with Internal NVOCC action from a sell shipment (that is assigned a service provider with this setting) on a job to create buy shipments and link them to a new job.
• isLocalizeBroadcastContact: boolean
  If "Y", use the preference /language, etc. of BROADCAST_SPOT_CONTACT. Otherwise, use shipment's LOGISTICS involved party's preference is used for broadcast notification.
• isMinority: boolean
  Select the Minority check box if the business is minority-owned.
• lineApproveTolProfileGid: string
  Indicates the line approval tolerance rule profile to apply.
• links: array links
  Read Only: true
• matchRuleProfileGid: string
  The GID for the match rule profile. Match Rule Profile Invoices are matched with existing shipments using an ordered list of rules. The Match Rule Profile is a group of service providers that follow the same rules for matching invoices to shipments.
• matchValidRuleProfileGid: string
  A profile for the match validation rules that should be tested if the Validate Match action is run on an invoice for this service provider.
• modeProfileGid: string
  A GID to define the mode profiles(group) that the service provider uses.
• nvoccDomainName: string
  The NVOCC Domain field determines the domain in which the buy shipments and new job are created.
• obtXmlProfileGid: string
  Associates the service provider with an online_booking_xml_profile, Which helps to define the content of XML to this service provider for UI display.
• outXmlProfileGid: string
  Associates the service provider with an out_xml_profile, which helps define the content of outgoing XML to this service provider.
• rateServiceGid: string
  Rate Service GID. This will be the default Rate Service used to re-drive the shipment if the service provider does not have a rate offering that matches the shipment
• scacGid: string
  The Standard Carrier Alpha Code for this Service Provider.
• scorecardValue: number (double)
  If you use a scorecard to organize your bids, enter a value in the Scorecard Value field.
• servprovGid: string
  The service provider GID.
• servprovLocation: servprovLocation
  The primary location for the service provider.
• servprovXid: string
  The service provider XID.
• sgTenderOutXmlProfileGid: string
  Associates the service provider with an out_xml_profile, which helps define the content of outgoing ship group tender XML to this service provider.
• sourcingContact: sourcingContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourcingContactGid: string
  The GID for the contact at the service provider who is responsible for sourcing activities.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• spotRateAdjustmentFactor: number (double)
  Spot Rate Adjustment Factor is the percentage factor to be applied to the spot rate for a service provider to adjust the spot rate for service provider performance. For example, 10% means a spot rate of $100 will be adjusted to 100 + 0.1 * 100 = $110.
• tenderResponseTime: tenderResponseTime
  The expected response time by this service provider for shipment tenders.
• tier: number (double)
  Enter a value in the Tier field to assign a numerical value to a service provider. The tier value is used to signify which service providers are more important than others.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "servprovGid":{
            "description":"The service provider GID.",
            "type":"string"
        },
        "servprovXid":{
            "description":"The service provider XID.",
            "type":"string"
        },
        "tenderResponseTime":{
            "description":"The expected response time by this service provider for shipment tenders.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "modeProfileGid":{
            "description":"A GID to define the mode profiles(group) that the service provider uses.",
            "type":"string"
        },
        "matchRuleProfileGid":{
            "description":"The GID for the match rule profile. Match Rule Profile Invoices are matched with existing shipments using an ordered list of rules. The Match Rule Profile is a group of service providers that follow the same rules for matching invoices to shipments.",
            "type":"string"
        },
        "matchValidRuleProfileGid":{
            "description":"A profile for the match validation rules that should be tested if the Validate Match action is run on an invoice for this service provider.",
            "type":"string"
        },
        "autoPaymentFlag":{
            "description":"Mark Autopay to have Oracle Transportation Management automatically create an invoice with every shipment for this service provider. Clear the check box, if you want to generate invoices manually in Settlement instead.",
            "type":"boolean"
        },
        "autoApproveRuleProfileGid":{
            "description":"The GID for the auto approve rule profile.",
            "type":"string"
        },
        "allocationRuleProfileGid":{
            "description":"The GID for the allocation rule profile. Allocation Rule Profile governs how your shipping costs are allocated.",
            "type":"string"
        },
        "isDispatchByRegion":{
            "description":"A flag to turn on/off the Tender by Locale feature.",
            "type":"boolean"
        },
        "allowTender":{
            "description":"Allow Tender determines whether the system can automatically tender (ordinary tender as opposed to Broadcast or Spot Bid tenders mentioned below) shipments to this service provider. Clear the check box to prevent the system from automatically tendering shipments to this service provider. If you have not loaded any rates into the system but still want to be able to create shipments, you may want to set up a dummy service provider with this check box cleared. You must mark this check box if you also plan to configure Broadcast/Spot Bid tendering for the service provider.<br>Note: Setting up a service provider's tender timeout requirements is done via the Contact Manager Notification Tab.",
            "type":"boolean"
        },
        "outXmlProfileGid":{
            "description":"Associates the service provider with an out_xml_profile, which helps define the content of outgoing XML to this service provider.",
            "type":"string"
        },
        "rateServiceGid":{
            "description":"Rate Service GID. This will be the default Rate Service used to re-drive the shipment if the service provider does not have a rate offering that matches the shipment",
            "type":"string"
        },
        "isAcceptSpotBids":{
            "description":"Is set to Y(es) if the service provider will participate in spot bid tendering.",
            "type":"boolean"
        },
        "isAcceptBroadcastTenders":{
            "description":"Is set to Y(es) if the service provider will participate in broadcast tendering.",
            "type":"boolean"
        },
        "isLocalizeBroadcastContact":{
            "description":"If \"Y\", use the preference /language, etc. of BROADCAST_SPOT_CONTACT. Otherwise, use shipment's LOGISTICS involved party's preference is used for broadcast notification.",
            "type":"boolean"
        },
        "spotRateAdjustmentFactor":{
            "description":"Spot Rate Adjustment Factor is the percentage factor to be applied to the spot rate for a service provider to adjust the spot rate for service provider performance. For example, 10% means a spot rate of $100 will be adjusted to 100 + 0.1 * 100 = $110.",
            "type":"number",
            "format":"double"
        },
        "broadcastSpotContactGid":{
            "description":"Overrides the shipper's primary contact to be used to determine localization preferences for tender notification. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "broadcastSpotContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "doConditionalAccepts":{
            "description":"Determines if the service provider can participate in conditional booking.",
            "type":"boolean"
        },
        "isInternalNvocc":{
            "description":"The Internal NVOCC check box identifies whether the service provider acts as an NVOCC (Non-Vessel Operating Common Carrier). If this check box is marked, you can use the Book with Internal NVOCC action from a sell shipment (that is assigned a service provider with this setting) on a job to create buy shipments and link them to a new job. ",
            "type":"boolean"
        },
        "nvoccDomainName":{
            "description":"The NVOCC Domain field determines the domain in which the buy shipments and new job are created.",
            "type":"string"
        },
        "isAcceptBySsuAllowed":{
            "description":"Mark the Allow Accept By Ship Unit check box to let a service provider partially accept a tender by its shipment's Transport Handling Units. Allowing a service provider to partially accept a tender gives service providers a role on the planning process. A new shipment and tender are created based off the amount the Service provider accepts. The original tender (minus the partially accepted units) is still available for future tendering.",
            "type":"boolean"
        },
        "isCopyInvDeltaBackToShip":{
            "description":"The Copy Invoice Delta to Shipment check box indicates whether differences between the approved amount and the amount on the actual invoice should be copied to the shipment. So for example, the shipment was $100, and the invoice was $100, but only $80 was approved and this check box was selected. Then the change, or delta, of $20 will be added to the shipment as an extra adjustment charge. This is not supported when the parent/consolidated invoice is approved by total.",
            "type":"boolean"
        },
        "invoicingProcess":{
            "description":"The Invoicing Process drop-down list box determines what type of invoice will be generated for shipments from this carrier. If it is set to Standard, then regular invoices will be generated. If you set it to BOL Back, then a BOL Back will be generated. BOL backs are often used for ocean shipments.",
            "type":"string"
        },
        "lineApproveTolProfileGid":{
            "description":"Indicates the line approval tolerance rule profile to apply.",
            "type":"string"
        },
        "scacGid":{
            "description":"The Standard Carrier Alpha Code for this Service Provider.",
            "type":"string"
        },
        "equipmentMarkListGid":{
            "description":"The Equipment Mark List for this Service Provider.",
            "type":"string"
        },
        "isMinority":{
            "description":"Select the Minority check box if the business is minority-owned.",
            "type":"boolean"
        },
        "incumbent":{
            "description":"Select the Incumbent check box to indicate that this service provider has been used previously.",
            "type":"boolean"
        },
        "tier":{
            "description":"Enter a value in the Tier field to assign a numerical value to a service provider. The tier value is used to signify which service providers are more important than others.",
            "type":"number",
            "format":"double"
        },
        "scorecardValue":{
            "description":"If you use a scorecard to organize your bids, enter a value in the Scorecard Value field.",
            "type":"number",
            "format":"double"
        },
        "epaIndexValue":{
            "description":"If the provider participates in the EPA Smartway program, record it's SIF in the EPA Smartway SIF field.",
            "type":"number",
            "format":"double"
        },
        "isFleet":{
            "description":"Only shipments created for fleet service providers can perform fleet related actions.",
            "type":"boolean"
        },
        "sourcingContactGid":{
            "description":"The GID for the contact at the service provider who is responsible for sourcing activities. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourcingContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "allowSpotRating":{
            "description":"Flag to indicate that service provider is valid for Spot Rating actions",
            "type":"boolean"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "obtXmlProfileGid":{
            "description":"Associates the service provider with an online_booking_xml_profile, Which helps to define the content of XML to this service provider for UI display.",
            "type":"string"
        },
        "isActive":{
            "description":"This flag will define whether service provider is active or not.By default this flag will be Y.",
            "type":"boolean"
        },
        "sgTenderOutXmlProfileGid":{
            "description":"Associates the service provider with an out_xml_profile, which helps define the content of outgoing ship group tender XML to this service provider.",
            "type":"string"
        },
        "allowSgTender":{
            "description":"Ship group allow tender determines whether the system can automatically tender  ship group to this service provider.By default it is set to 'N'",
            "type":"boolean"
        },
        "servprovLocation":{
            "description":"The primary location for the service provider.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "aliases":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/serviceProviders.aliases"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/serviceProviders.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : aliases

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceProviders.aliases"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : broadcastSpotContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property broadcastSpotContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/serviceProviders.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : servprovLocation

The primary location for the service provider.

Match All

The primary location for the service provider.

Show Source

• object locations

{
    "description":"The primary location for the service provider.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ]
}

Nested Schema : sourcingContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcingContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : tenderResponseTime

The expected response time by this service provider for shipment tenders.

Match All

The expected response time by this service provider for shipment tenders.

Show Source

• object amountType

{
    "description":"The expected response time by this service provider for shipment tenders.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceProviders.aliases"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• alias: string
  Alias provides an alternate way of identifying service providers. For example, you may want to set up an alias that identifies the SCAC of a service provider. Alternatively, you may want to set up an alias for XY-Z company with a Qualifier ID of SCAC and an alias of ZXY.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• servprovAliasQualGid: string
  The GID for the service provider alias qualifier.

{
    "properties":{
        "servprovAliasQualGid":{
            "description":"The GID for the service provider alias qualifier.",
            "type":"string"
        },
        "alias":{
            "description":"Alias provides an alternate way of identifying service providers. For example, you may want to set up an alias that identifies the SCAC of a service provider.  Alternatively, you may want to set up an alias for XY-Z company with a Qualifier ID of SCAC and an alias of ZXY.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object serviceProviders.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/serviceProviders.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : serviceProviders.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationRefnumQualGid: string
  The GID for the location reference number qualifier.
• locationRefnumValue: string
  The value associated with the location reference number qualifier.

{
    "properties":{
        "locationRefnumQualGid":{
            "description":"The GID for the location reference number qualifier.",
            "type":"string"
        },
        "locationRefnumValue":{
            "description":"The value associated with the location reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier for the location.
• remarkSequence: number (int64)
  The sequence number for the remark for this location.
• remarkText: string
  The text of the remark for the location.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the remark for this location.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier for the location.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark for the location.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceGroups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.resourceGroups

Type: object

Show Source

• calendarGid: string
  The calendar GID that will be applied to the location of the location resource group.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationResourceGroupGid: string
  The GID for the location resource group. Option here is to link a calendar and preference level for a location resource group.
• preferenceLevel: number (int32)
  Used to get preference level of location resource group for Appointment scheduling

{
    "properties":{
        "locationResourceGroupGid":{
            "description":"The GID for the location resource group. Option here is to link a calendar and preference level for a location resource group.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID that will be applied to the location of the location resource group.",
            "type":"string"
        },
        "preferenceLevel":{
            "description":"Used to get preference level of location resource group for Appointment scheduling",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.resourceTypes

Type: object

Show Source

• autoScheduleAppointment: boolean
  Indicate whether appointment should be automatically scheduled for the resource type.
• calendarGid: string
  The calendar GID that applies to the location resource type.
• constraintAppointment: boolean
  Whether the location resource type constraints scheduling appointments.
• description: string
  The description of the location resource type.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• resources: resources
• resourceTypeGid: string
  Resource Type GID for the location.

{
    "properties":{
        "resourceTypeGid":{
            "description":"Resource Type GID for the location.",
            "type":"string"
        },
        "description":{
            "description":"The description of the location resource type.",
            "type":"string"
        },
        "constraintAppointment":{
            "description":"Whether the location resource type constraints scheduling appointments.",
            "type":"boolean"
        },
        "calendarGid":{
            "description":"The calendar GID that applies to the location resource type.",
            "type":"string"
        },
        "autoScheduleAppointment":{
            "description":"Indicate whether appointment should be automatically scheduled for the resource type.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "resources":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : resources

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes.resources

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.resourceTypes.resources

Type: object

Show Source

• appointmentActivityType: string
  Specify if the trailer that is scheduled for the appointment is attached to the truck by selecting Live from the Appointment Activity Type field. If the trailer is being dropped off, select Drop.
• apptRuleSets: apptRuleSets
• calendarGid: string
  The calendar GID that will be applied to the resource.
• contactProfileGid: string
  The contact profile GID.
• description: string
  The description of the resource.
• domainName: string
  Database domain where this data is stored.
• equipmentGroupProfileGid: string
  The equipment group profile ID that associates to the location resource.
• flexCommodityCheckOption: string
  Flex Commodify check option, such as CHECK ALL, CHECK BY LARGEST WEIGHT and CHECK BY LARGEST VOLUME.
• flexCommodityProfileGid: string
  The flex commodity profile ID that associates to the location resource.
• links: array links
  Read Only: true
• locationResourceGid: string
  The location resource GID.
• locationResourceGroupGid: string
  The XID for the location resource group. A location resource group allows you to group location resources such as dock door1, dock door2, and dock door3 into a location resource group such as frozen goods into a group called frozen. Similarly, you can group location resources into a location resource group such as dry goods into a group called dry. While you create a location resource group, you can also assign locations. For each location, you can assign multiple appointment rule sets. These rules sets are applicable to all the resources which are under the location resource group. A location resource group enables you to avoid duplicate configurations for each resource.
• locationResourceName: string
  The name of the resource.
• locationResourceXid: string
  The XID of the location resource.
• modeProfileGid: string
  The mode profile ID that associates to the location resource.
• preferenceLevel: number (int32)
  Gets the preference level of resource for Appointment scheduling
• servprovProfileGid: string
  The service provider profile ID that associates to the location resource.

{
    "properties":{
        "locationResourceGid":{
            "description":"The location resource GID.",
            "type":"string"
        },
        "locationResourceXid":{
            "description":"The XID of the location resource.",
            "type":"string"
        },
        "locationResourceName":{
            "description":"The name of the resource.",
            "type":"string"
        },
        "description":{
            "description":"The description of the resource.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The calendar GID that will be applied to the resource.",
            "type":"string"
        },
        "flexCommodityProfileGid":{
            "description":"The flex commodity profile ID that associates to the location resource.",
            "type":"string"
        },
        "equipmentGroupProfileGid":{
            "description":"The equipment group profile ID that associates to the location resource.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The mode profile ID that associates to the location resource.",
            "type":"string"
        },
        "servprovProfileGid":{
            "description":"The service provider profile ID that associates to the location resource.",
            "type":"string"
        },
        "contactProfileGid":{
            "description":"The contact profile GID.",
            "type":"string"
        },
        "flexCommodityCheckOption":{
            "description":"Flex Commodify check option, such as CHECK ALL, CHECK BY LARGEST WEIGHT and CHECK BY LARGEST VOLUME.",
            "type":"string"
        },
        "appointmentActivityType":{
            "description":"Specify if the trailer that is scheduled for the appointment is attached to the truck by selecting Live from the Appointment Activity Type field. If the trailer is being dropped off, select Drop.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "preferenceLevel":{
            "description":"Gets the preference level of resource for Appointment scheduling",
            "type":"number",
            "format":"int32"
        },
        "locationResourceGroupGid":{
            "description":"The XID for the location resource group. A location resource group allows you to group location resources such as dock door1, dock door2, and dock door3 into a location resource group such as frozen goods into a group called frozen. Similarly, you can group location resources into a location resource group such as dry goods into a group called dry. While you create a location resource group, you can also assign locations. For each location, you can assign multiple appointment rule sets. These rules sets are applicable to all the resources which are under the location resource group. A location resource group enables you to avoid duplicate configurations for each resource.",
            "type":"string"
        },
        "apptRuleSets":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : apptRuleSets

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes.resources.apptRuleSets

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.resourceTypes.resources.apptRuleSets

Type: object

Show Source

• apptRuleSetGid: string
  The GID for the appointment rule set.
• domainName: string
  Database domain where this data is stored.
• flexFields: flexFields
• links: array links
  Read Only: true
• refnums: refnums

{
    "properties":{
        "apptRuleSetGid":{
            "description":"The GID for the appointment rule set.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexFields":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.flexFields"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : flexFields

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.flexFields"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes.resources.apptRuleSets.flexFields

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.flexFields"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.resourceTypes.resources.apptRuleSets.flexFields

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• flexFieldName: string
  Flex field name
• flexFieldValue: string
  Flex field value.
• isCompatible: boolean
  If the flex field details on the shipment contain all the flex field details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
  If you do not specify any shipment flex fields on your appointment rule set, the shipment is considered as compatible.
• links: array links
  Read Only: true

{
    "properties":{
        "flexFieldName":{
            "description":"Flex field name",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexFieldValue":{
            "description":"Flex field value.",
            "type":"string"
        },
        "isCompatible":{
            "description":"If the flex field details on the shipment contain all the flex field details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.<br>If you do not specify any shipment flex fields on your appointment rule set, the shipment is considered as compatible.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.resourceTypes.resources.apptRuleSets.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.resourceTypes.resources.apptRuleSets.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.resourceTypes.resources.apptRuleSets.refnums

Type: object

Show Source

• apptRefnumQualGid: string
  The appointment reference number qualifier. The qualifier related to shipment is used.
• apptRefnumValue: string
  The appointment reference number value.
• domainName: string
  Database domain where this data is stored.
• isCompatible: boolean
  If the reference number details on the shipment contain all the reference number details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.
  If you do not specify any shipment reference numbers on your appointment rule set, the shipment is considered as compatible.
  For example, the following table contains reference number details on the shipment and appointment rule sets along with the status of compatible check box of individual rule sets.
  Shipment Reference Number Qualifier and Value
  Appointment Rule Set Reference Number Qualifier and Value
  Q1 V1 Q1 V1, selected
  Q2 V2 Q2 V2, selected
  Q3 V3
  Q4 V4
  In this example, the shipment is compatible as the reference numbers on the shipment contain reference numbers (Q1 V1), (Q2 V2) that are defined in the appointment rule set with the compatible check box as selected.
  To define shipment reference numbers constraints, enter or select the following fields, which are optional:
  Reference Number Qualifier ID.
  Reference Number.
• links: array links
  Read Only: true

{
    "properties":{
        "apptRefnumQualGid":{
            "description":"The appointment reference number qualifier. The qualifier related to shipment is used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "apptRefnumValue":{
            "description":"The appointment reference number value.",
            "type":"string"
        },
        "isCompatible":{
            "description":"If the reference number details on the shipment contain all the reference number details defined on the appointment rule set, when the Compatible check box is selected for each appointment rule set, then the shipment is compatible.<br>If you do not specify any shipment reference numbers on your appointment rule set, the shipment is considered as compatible.<br>For example, the following table contains reference number details on the shipment and appointment rule sets along with the status of compatible check box of individual rule sets.<br>Shipment Reference Number Qualifier and Value<br>Appointment Rule Set Reference Number Qualifier and Value<br>Q1 V1 Q1 V1, selected<br>Q2 V2 Q2 V2, selected<br>Q3 V3  <br>Q4 V4  <br>In this example, the shipment is compatible as the reference numbers on the shipment contain reference numbers (Q1 V1), (Q2 V2) that are defined in the appointment rule set with the compatible check box as selected.  <br>To define shipment reference numbers constraints, enter or select the following fields, which are optional:<br>Reference Number Qualifier ID.<br>Reference Number.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.roleProfiles

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.roleProfiles

Type: object

Show Source

• activityTimeDefs: activityTimeDefs
• calendarGid: string
  The GID for the calendar used for the location role profile.
• calendars: calendars
• createPoolHandlingShipment: boolean
  Creates pool handling shipments.
• createXdockHandlingShipment: boolean
  Using the Create Crossdock Handling Shipment field creates handling shipments as part of the cross-dock building process. Clear the check box to bulk plan cross-docks without handling shipments.
  Fixed Handling Time: Same as above.
  The Variable Handling Time and the Variable Handling Weight: Same as above.
  Max Freight Idle Time: Same as above.
• domainName: string
  Database domain where this data is stored.
• fixedHandlingTime: fixedHandlingTime
  Fixed amount of time. No matter the size of the shipment required for handling.
• handlings: handlings
• isAllowMixedFreight: boolean
  Check box option used to indicate if mixed freight (e.g., a rainbow pallet) will be allowed, is so then select the Allow Mixed Freight option.
• links: array links
  Read Only: true
• locationRoleGid: string
  The GID for the location role.
• maxFreightIdleTime: maxFreightIdleTime
  Maximum time freight can sit idle at the cross-dock.
• pctActivityAfterLocClose: number (double)
  This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 100 100. when null, treat as for location role shipping receiving< div>
• pctActivityBeforeLocOpen: number (double)
  This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 0 100. when it is null, treat as for location role shipping receiving< div>
• thuCapacities: thuCapacities
• thuProfileGid: string
  The GID for the transport profile.
  To handle mixed items you need to include the THU profile here and on the order release line. You also need to attach appropriate packaging reference unit (PRU) to the THU to indicate that it is a mixed THU that takes only mixed items but does not take SAME or LIKE items. See Order Release Line help for details.
• varHandlingTime: varHandlingTime
  Amount of time required to handle the amount of weight defined by the variable handling weight value.
• varHandlingWeight: varHandlingWeight
  Variable handling time weight defines rate of handling defined by weight.
• varHndcstVol: varHndcstVol
  The planning handling cost volume at this location.
• varHndcstVolCost: varHndcstVolCost
  The variable handling cost per volume at this location.
• varHndcstWgt: varHndcstWgt
  The planning handling cost weight at this location.
• varHndcstWgtCost: varHndcstWgtCost
  Variable Handling Cost Per Weight at this location.
• xDockIsInboundBias: boolean
  The inbound bias flag for the cross-dock should be selected if you want to emphasize optimization inbound to the cross-dock. If you clear the check box, then the system will optimize outbound from the cross-dock instead.

{
    "properties":{
        "locationRoleGid":{
            "description":"The GID for the location role.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The GID for the calendar used for the location role profile.",
            "type":"string"
        },
        "xDockIsInboundBias":{
            "description":"The inbound bias flag for the cross-dock should be selected if you want to emphasize optimization inbound to the cross-dock. If you clear the check box, then the system will optimize outbound from the cross-dock instead.",
            "type":"boolean"
        },
        "fixedHandlingTime":{
            "description":"Fixed amount of time. No matter the size of the shipment required for handling.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "varHandlingTime":{
            "description":"Amount of time required to handle the amount of weight defined by the variable handling weight value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "createXdockHandlingShipment":{
            "description":"Using the Create Crossdock Handling Shipment field creates handling shipments as part of the cross-dock building process. Clear the check box to bulk plan cross-docks without handling shipments.<br>Fixed Handling Time: Same as above.<br>The Variable Handling Time and the Variable Handling Weight: Same as above.<br>Max Freight Idle Time: Same as above.",
            "type":"boolean"
        },
        "createPoolHandlingShipment":{
            "description":"Creates pool handling shipments.",
            "type":"boolean"
        },
        "varHandlingWeight":{
            "description":"Variable handling time weight defines rate of handling defined by weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxFreightIdleTime":{
            "description":"Maximum time freight can sit idle at the cross-dock.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "pctActivityBeforeLocOpen":{
            "description":"This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 100. When it is null, treat as 0 for location role SHIPPING/RECEIVING",
            "type":"number",
            "format":"double"
        },
        "pctActivityAfterLocClose":{
            "description":"This value will be divided by 100 in the application to be used as a percentage. The valid value for this column is >= 0 and <= 100. When null, treat as 100 for location role SHIPPING/RECEIVING",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isAllowMixedFreight":{
            "description":"Check box option used to indicate if mixed freight (e.g., a rainbow pallet) will be allowed, is so then select the Allow Mixed Freight option.",
            "type":"boolean"
        },
        "thuProfileGid":{
            "description":"The GID for the transport profile.<br>To handle mixed items you need to include the THU profile here and on the order release line. You also need to attach appropriate packaging reference unit (PRU) to the THU to indicate that it is a mixed THU that takes only mixed items but does not take SAME or LIKE items. See Order Release Line help for details.",
            "type":"string"
        },
        "varHndcstWgt":{
            "description":"The planning handling cost weight at this location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "varHndcstWgtCost":{
            "description":"Variable Handling Cost Per Weight at this location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "varHndcstVol":{
            "description":"The planning handling cost volume at this location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "varHndcstVolCost":{
            "description":"The variable handling cost per volume at this location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "activityTimeDefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.activityTimeDefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "calendars":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.calendars"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "thuCapacities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "handlings":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.handlings"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTimeDefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.activityTimeDefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : calendars

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.calendars"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : fixedHandlingTime

Fixed amount of time. No matter the size of the shipment required for handling.

Match All

Fixed amount of time. No matter the size of the shipment required for handling.

Show Source

• object amountType

{
    "description":"Fixed amount of time. No matter the size of the shipment required for handling.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : handlings

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.handlings"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxFreightIdleTime

Maximum time freight can sit idle at the cross-dock.

Match All

Maximum time freight can sit idle at the cross-dock.

Show Source

• object amountType

{
    "description":"Maximum time freight can sit idle at the cross-dock.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : thuCapacities

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : varHandlingTime

Amount of time required to handle the amount of weight defined by the variable handling weight value.

Match All

Amount of time required to handle the amount of weight defined by the variable handling weight value.

Show Source

• object amountType

{
    "description":"Amount of time required to handle the amount of weight defined by the variable handling weight value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : varHandlingWeight

Variable handling time weight defines rate of handling defined by weight.

Match All

Variable handling time weight defines rate of handling defined by weight.

Show Source

• object amountType

{
    "description":"Variable handling time weight defines rate of handling defined by weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : varHndcstVol

The planning handling cost volume at this location.

Match All

The planning handling cost volume at this location.

Show Source

• object amountType

{
    "description":"The planning handling cost volume at this location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : varHndcstVolCost

The variable handling cost per volume at this location.

Match All

The variable handling cost per volume at this location.

Show Source

• object currencyType

{
    "description":"The variable handling cost per volume at this location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : varHndcstWgt

The planning handling cost weight at this location.

Match All

The planning handling cost weight at this location.

Show Source

• object amountType

{
    "description":"The planning handling cost weight at this location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : varHndcstWgtCost

Variable Handling Cost Per Weight at this location.

Match All

Variable Handling Cost Per Weight at this location.

Show Source

• object currencyType

{
    "description":"Variable Handling Cost Per Weight at this location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.roleProfiles.activityTimeDefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.activityTimeDefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.roleProfiles.activityTimeDefs

Type: object

Show Source

• activityTimeDefGid: string
  The GID for the activity time definition for this location and location role combination.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "activityTimeDefGid":{
            "description":"The GID for the activity time definition for this location and location role combination.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.roleProfiles.calendars

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.calendars"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.roleProfiles.calendars

Type: object

Show Source

• calendarGid: string
  The GID for the calendar entry associated with each row of the location role profile calendar entry.
• domainName: string
  Database domain where this data is stored.
• flexCommodityProfileGid: string
  The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.
• inboundLocationProfileGid: string
  The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.
• links: array links
  Read Only: true
• locationRoleProfCalSeq: number (int32)
  The internal sequence number for the location role profile calendar combination.
• modeProfileGid: string
  The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.
• outboundLocationProfileGid: string
  The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.

{
    "properties":{
        "locationRoleProfCalSeq":{
            "description":"The internal sequence number for the location role profile calendar combination.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "flexCommodityProfileGid":{
            "description":"The GID for the flex commodity profile. Used to specify when commodity specific activities can occur at the location.",
            "type":"string"
        },
        "inboundLocationProfileGid":{
            "description":"The GID for the inbound location profile. Used to specify when shipments from locations in the inbound location profile can be received at the location.",
            "type":"string"
        },
        "outboundLocationProfileGid":{
            "description":"The GID for the outbound location profile. Used to specify when shipments to locations in the outbound location profile can be shipped to.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The GID for the calendar entry associated with each row of the location role profile calendar entry.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The GID for the mode profile. Used to specify when shipments of a certain mode can be shipped or received from the location.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.roleProfiles.handlings

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.handlings"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.roleProfiles.handlings

Type: object

Show Source

• destRegionGid: string
  The GID for the destination region. Used to match an order to an entry.
• domainName: string
  Database domain where this data is stored.
• fixedHandlingTime: fixedHandlingTime
  Amount fixed handling time to add. Days, hours, and minutes.
• links: array links
  Read Only: true
• locationRoleProfHandSeq: number (int32)
  Internal key for the 1 to n location role profile handling time entries.
• sourceRegionGid: string
  The GID for the source region. Used to match an order to an entry.

{
    "properties":{
        "locationRoleProfHandSeq":{
            "description":"Internal key for the 1 to n location role profile handling time entries.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sourceRegionGid":{
            "description":"The GID for the source region. Used to match an order to an entry.",
            "type":"string"
        },
        "destRegionGid":{
            "description":"The GID for the destination region. Used to match an order to an entry.",
            "type":"string"
        },
        "fixedHandlingTime":{
            "description":"Amount fixed handling time to add. Days, hours, and minutes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : fixedHandlingTime

Amount fixed handling time to add. Days, hours, and minutes.

Match All

Amount fixed handling time to add. Days, hours, and minutes.

Show Source

• object amountType

{
    "description":"Amount fixed handling time to add. Days, hours, and minutes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.roleProfiles.thuCapacities

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.roleProfiles.thuCapacities

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• isFullyLayered: boolean
  You should select the Fully Layered check box if this location only takes a full-layered ship unit based on the TiHi definition. A full-layered ship unit has no partial layers. For example, you are packing 23 boxes into a given PALLET (THU) and the TiHi specified for the pallet is 6 x 4. Normally, you would pack them onto one pallet with 3 full layers and one partial layer of 5 boxes. However, if you allow only full layers, you would pack only 3 full layers and leave the remaining 5 to pack with other items.
  Building a full layered ship unit, when required, would only be honored when a ship unit is building from a single order release line using the AUTO CALC ship unit building method. It will not be honored when ship unit is built from multiple order release lines even when those lines have the same packaged item.
• links: array links
  Read Only: true
• maxHeight: maxHeight
  Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
• maxLength: maxLength
  Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
• maxVolume: maxVolume
  Value for the maximum volume of the transportation handling unit.
• maxWeight: maxWeight
  Value for the maximum weight of the transportation handling unit.
• maxWidth: maxWidth
  Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.
• pruCapacities: pruCapacities
• transportHandlingUnitGid: string
  The GID for the transport handling unit.

{
    "properties":{
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "maxLength":{
            "description":"Value for the maximum length of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWidth":{
            "description":"Value for the maximum width of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxHeight":{
            "description":"Value for the maximum height of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWeight":{
            "description":"Value for the maximum weight of the  transportation handling unit. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"Value for the maximum volume of the  transportation handling unit. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isFullyLayered":{
            "description":"You should select the Fully Layered check box if this location only takes a full-layered ship unit based on the TiHi definition. A full-layered ship unit has no partial layers. For example, you are packing 23 boxes into a given PALLET (THU) and the TiHi specified for the pallet is 6 x 4. Normally, you would pack them onto one pallet with 3 full layers and one partial layer of 5 boxes. However, if you allow only full layers, you would pack only 3 full layers and leave the remaining 5 to pack with other items.<br>Building a full layered ship unit, when required, would only be honored when a ship unit is building from a single order release line using the AUTO CALC ship unit building method. It will not be honored when ship unit is built from multiple order release lines even when those lines have the same packaged item.",
            "type":"boolean"
        },
        "pruCapacities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities.pruCapacities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxHeight

Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Match All

Value for the maximum height of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Show Source

• object amountType

{
    "description":"Value for the maximum height of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxLength

Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Match All

Value for the maximum length of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Show Source

• object amountType

{
    "description":"Value for the maximum length of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxVolume

Value for the maximum volume of the transportation handling unit.

Match All

Value for the maximum volume of the transportation handling unit.

Show Source

• object amountType

{
    "description":"Value for the maximum volume of the  transportation handling unit. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

Value for the maximum weight of the transportation handling unit.

Match All

Value for the maximum weight of the transportation handling unit.

Show Source

• object amountType

{
    "description":"Value for the maximum weight of the  transportation handling unit. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWidth

Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Match All

Value for the maximum width of the transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.

Show Source

• object amountType

{
    "description":"Value for the maximum width of the  transportation handling unit. Note: The Max Width field (as well as the Max Length and Max Height fields) are different from the Max Weight and Max Volume fields that are used to constrain the ship unit. The Max Width (and Length and Height) are used to check against each packaging unit or packaged item, not the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pruCapacities

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities.pruCapacities"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.roleProfiles.thuCapacities.pruCapacities

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.roleProfiles.thuCapacities.pruCapacities"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.roleProfiles.thuCapacities.pruCapacities

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• limitPruCount: number (double)
  Enter a Total Packaging Reference Unit Count. This total represents by volume the amount of packaging reference units that can fill the space. It does not take into account the actual shape and dimensions of the packaging reference unit, but rather how many packaging reference units can fit in the space based on the volume of each packaging reference unit.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The GID for the package unit reference unit.
• totalPruCount: number (double)
  Enter a Limit Packaging Reference Unit Count. This represents the number of package references units that can fill the usable space in the location. The area of a location may suggest more packaging reference units can fit, but due to the actual dimensions of the packaged reference units, a lower limit may be reached.

{
    "properties":{
        "packagingReferenceUnitGid":{
            "description":"The GID for the package unit reference unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "totalPruCount":{
            "description":"Enter a Limit Packaging Reference Unit Count. This represents the number of package references units that can fill the usable space in the location. The area of a location may suggest more packaging reference units can fit, but due to the actual dimensions of the packaged reference units, a lower limit may be reached.",
            "type":"number",
            "format":"double"
        },
        "limitPruCount":{
            "description":"Enter a Total Packaging Reference Unit Count. This total represents by volume the amount of packaging reference units that can fill the space. It does not take into account the actual shape and dimensions of the packaging reference unit, but rather how many packaging reference units can fit in the space based on the volume of each packaging reference unit.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.servprovPrefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.servprovPrefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.servprovPrefs

Type: object

Show Source

• details: details
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationServprovPrefGid: string
  The unique identifier of location service provider preference.
• locationServprovPrefXid: string
  The XID of location service provider preference.
• maxSlotsPerDay: number (int32)
  The maximum number of slots per day.
• serviceLocation: serviceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• serviceLocationGid: string
  Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The Service Provider GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "locationServprovPrefGid":{
            "description":"The unique identifier of location service provider preference.",
            "type":"string"
        },
        "locationServprovPrefXid":{
            "description":"The XID of location service provider preference.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The Service Provider GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "maxSlotsPerDay":{
            "description":"The maximum number of slots per day.",
            "type":"number",
            "format":"int32"
        },
        "serviceLocationGid":{
            "description":"Unique key constraint will be created on (location_gid, servprov_gid, service_location_gid) in CU5. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "serviceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/locations.servprovPrefs.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/locations.servprovPrefs.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : serviceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property serviceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.servprovPrefs.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.servprovPrefs.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.servprovPrefs.details

Type: object

Show Source

• begin: number (int32)
  The begin time.
• dayOfWeek: number (int32)
  The day of week.
• domainName: string
  Database domain where this data is stored.
• duration: number (int32)
  The duration of the time window.
• isStanding: boolean
  Indicates if the defined preference is for standing appointment.
• links: array links
  Read Only: true
• locationResourceGid: string
  Indicates the resource that preference defined on.
• locationServprovPrefDSeq: number (int64)
  Sequence with in a particular location service provider preference GID.
• maxSlot: number (int32)
  The maximum number of slots during this time.
• preferenceLevel: number (int32)
  The preference level.

{
    "properties":{
        "locationServprovPrefDSeq":{
            "description":"Sequence with in a particular location service provider preference GID.",
            "type":"number",
            "format":"int64"
        },
        "dayOfWeek":{
            "description":"The day of week.",
            "type":"number",
            "format":"int32"
        },
        "begin":{
            "description":"The begin time.",
            "type":"number",
            "format":"int32"
        },
        "preferenceLevel":{
            "description":"The preference level.",
            "type":"number",
            "format":"int32"
        },
        "duration":{
            "description":"The duration of the time window.",
            "type":"number",
            "format":"int32"
        },
        "maxSlot":{
            "description":"The maximum number of slots during this time.",
            "type":"number",
            "format":"int32"
        },
        "locationResourceGid":{
            "description":"Indicates the resource that preference defined on.",
            "type":"string"
        },
        "isStanding":{
            "description":"Indicates if the defined preference is for standing appointment.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceCodeGid: string
  The GID for the special service code for the location.

{
    "properties":{
        "specialServiceCodeGid":{
            "description":"The GID for the special service code for the location.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  Status type for the location status.
• statusValueGid: string
  Status value for the status type.

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the location status.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Status value for the status type.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object locations.substitutes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.substitutes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations.substitutes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• substituteLocationGid: string
  The GID for the substitute location. Use this field to define ONE alternate location from which an order is picked up for transportation purposes. For example, for any ship unit or line item on an order, you can record a Source Location and Destination Location that would typically be used to plan a shipment. However, if you record a Substitute Location for any location that is used as a Source Location on an order, Oracle Transportation Management automatically uses the Substitute Location and populates it on the order release. Oracle Transportation Management also uses the Substitute Location on the order release as the source location when building a shipment; however you can override this location on the order base and order release.

{
    "properties":{
        "substituteLocationGid":{
            "description":"The GID for the substitute location.  Use this field to define ONE alternate location from which an order is picked up for transportation purposes. For example, for any ship unit or line item on an order, you can record a Source Location and Destination Location that would typically be used to plan a shipment. However, if you record a Substitute Location for any location that is used as a Source Location on an order, Oracle Transportation Management automatically uses the Substitute Location and populates it on the order release. Oracle Transportation Management also uses the Substitute Location on the order release as the source location when building a shipment; however you can override this location on the order base and order release.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• allowLifoOnly: boolean
  Indicates whether the equipment is for LIFO only.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• axleLoadingWeights: axleLoadingWeights
• combEquipGrpStructSeq: number (int32)
  If the equipment group is a composite equipment group, it will have this comb_equip_grp_struct_seq populated. It contains the list of equipment groups that belong to a double or triple.
• commodityGid: string
  The commodity that is compatible with the equipment group.
• compartments: compartments
• compartmentTypeGid: string
  A GID to define the compartment type.
• curveGid: string
  Defined the curve function of the curved roof of the equipment group.
• domainName: string
  Database domain where this data is stored.
• doorHeight: doorHeight
  Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.
• effectiveVolume: effectiveVolume
  The capacity for the equipment.
• effectiveWeight: effectiveWeight
  The weight of the equipment.
• emptyCgHeight: emptyCgHeight
  When empty, indicates the height from Top of Rail to the Center of Gravity.
• emptyCgLength: emptyCgLength
  When empty, length wise position of center of gravity from the equipment bottom leftmost corner.
• emptyCgWidth: emptyCgWidth
  When empty, width wise position of center of gravity from the equipment bottom leftmost corner.
• equipMaxGrossWt: equipMaxGrossWt
  The maximum permissible weight of the equipment and the load.
• equipmentGroupGid: string
  The GID for the equipment group.
• equipmentGroupName: string
  Describes the group of equipment.
• equipmentGroupXid: string
  The XID for the equipment group.
• equipmentOwnerType: string
  The type of company that owns the stenciled mark on the equipment. For example private or carrier.
• equipmentRefUnits: equipmentRefUnits
• equipmentTypeCode: string
  Alphanumeric code used to designate a specific type of equipment and attributes.
• equipmentTypes: equipmentTypes
• exteriorHeight: exteriorHeight
  Stores the exterior height of the equipment group.
• exteriorLength: exteriorLength
  Stores the exterior length of the equipment group.
• exteriorWidth: exteriorWidth
  Stores the width length of the equipment group.
• feuEquivalentCount: number (double)
  The forty foot unit equivalent count for this equipment group.
• floorHeight: floorHeight
  Actual height of the platform or floor above the ground or the rail.
• hasMeter: boolean
  Indicates if the compartment has METER or not. (The METER is a device that is used the measure how much product is discharged at any given stop).
• height: height
  The height of the equipment group.
• insertDate: insertDate
  Read Only: true

  insert date
• isBulk: boolean
  Indicates if it is a BULK. If Y then BULK If N then PACKAGED.
• isContainer: boolean
  The is container check box to identifies container equipment groups. Equipment groups with this check box marked are considered during the unitization process that can occur when running the Build Buy Shipment on Primary Leg action for an order release.
• length: length
  The length of the equipment group.
• links: array links
  Read Only: true
• maxAxleWeight: maxAxleWeight
  Maximum allowed axle weight. Applicable only to rail cars.
• maxHeightPerUnit: maxHeightPerUnit
  Stores the maximum per ship unit height allowed.
• maxLengthPerUnit: maxLengthPerUnit
  Stores the maximum per ship unit length allowed.
• maxLhsWeight: maxLhsWeight
  The max weight allowed on the left hand side of the equipment.
• maxRhsWeight: maxRhsWeight
  The max weight allowed on the right hand side of the equipment.
• maxSideWeightDiff: maxSideWeightDiff
  The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.
• maxWidthPerUnit: maxWidthPerUnit
  Stores the maximum per ship unit width allowed.
• mechanicalDesignation: string
  Alphabetic code assigned to the physical description of the unit.
• obstructions: obstructions
• packagedItems: packagedItems
• pullingLength: pullingLength
  Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.
• shipUnitSpecCompatibilities: shipUnitSpecCompatibilities
• tareWeight: tareWeight
  The tare weight of the equipment group.
• temperatureControlGid: string
  A GID to define the temperature controls value for the commodity.
• teuEquivalentCount: number (double)
  The twenty foot unit equivalent count for this equipment group.
• totalAxleCount: number (int32)
  The total number of axles on the equipment. Applicable only to rail cars.
• truckCenterLength: truckCenterLength
  The length between the centers of the two truck/bogie systems. Applicable only to rail cars.
• truckCount: number (int32)
  The total number of trucks/bogies on the equipment. Applicable only to rail cars.
• truckTypeGid: string
  An GID to define the Truck Type to Categorize the Equipment Group.
• updateDate: updateDate
  Read Only: true

  update date
• vehicleTypeCompatibilities: vehicleTypeCompatibilities
• width: width
  The width of the equipment group.

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group.",
            "type":"string"
        },
        "equipmentGroupXid":{
            "description":"The XID for the equipment group.",
            "type":"string"
        },
        "equipmentGroupName":{
            "description":"Describes the group of equipment.",
            "type":"string"
        },
        "temperatureControlGid":{
            "description":"A GID to define the temperature controls value for the commodity.",
            "type":"string"
        },
        "effectiveWeight":{
            "description":"The weight of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "effectiveVolume":{
            "description":"The capacity for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "length":{
            "description":"The length of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "teuEquivalentCount":{
            "description":"The twenty foot unit equivalent count for this equipment group.",
            "type":"number",
            "format":"double"
        },
        "feuEquivalentCount":{
            "description":"The forty foot unit equivalent count for this equipment group.",
            "type":"number",
            "format":"double"
        },
        "doorHeight":{
            "description":"Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "curveGid":{
            "description":"Defined the curve function of the curved roof of the equipment group.",
            "type":"string"
        },
        "isContainer":{
            "description":"The is container check box to identifies container equipment groups. Equipment groups with this check box marked are considered during the unitization process that can occur when running the Build Buy Shipment on Primary Leg action for an order release.",
            "type":"boolean"
        },
        "maxLhsWeight":{
            "description":"The max weight allowed on the left hand side of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxRhsWeight":{
            "description":"The max weight allowed on the right hand side of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxSideWeightDiff":{
            "description":"The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "allowLifoOnly":{
            "description":"Indicates whether the equipment is for LIFO only.",
            "type":"boolean"
        },
        "maxLengthPerUnit":{
            "description":"Stores the maximum per ship unit length allowed. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWidthPerUnit":{
            "description":"Stores the maximum per ship unit width allowed. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxHeightPerUnit":{
            "description":"Stores the maximum per ship unit height allowed. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "exteriorLength":{
            "description":"Stores the exterior length of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorWidth":{
            "description":"Stores the width length of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorHeight":{
            "description":"Stores the exterior height of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "combEquipGrpStructSeq":{
            "description":"If the equipment group is a composite equipment group, it will have this comb_equip_grp_struct_seq populated. It contains the list of equipment groups that belong to a double or triple.",
            "type":"number",
            "format":"int32"
        },
        "compartmentTypeGid":{
            "description":"A GID to define the compartment type.",
            "type":"string"
        },
        "hasMeter":{
            "description":"Indicates if the compartment has METER or not. (The METER is a device that is used the measure how much product is discharged at any given stop).",
            "type":"boolean"
        },
        "commodityGid":{
            "description":"The commodity that is compatible with the equipment group.",
            "type":"string"
        },
        "isBulk":{
            "description":"Indicates if it is a BULK. If Y then BULK If N then PACKAGED.",
            "type":"boolean"
        },
        "equipmentTypeCode":{
            "description":"Alphanumeric code used to designate a specific type of equipment and attributes.",
            "type":"string"
        },
        "mechanicalDesignation":{
            "description":"Alphabetic code assigned to the physical description of the unit.",
            "type":"string"
        },
        "equipmentOwnerType":{
            "description":"The type of company that owns the stenciled mark on the equipment. For example private or carrier.",
            "type":"string"
        },
        "equipMaxGrossWt":{
            "description":"The maximum permissible weight of the equipment and the load.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "floorHeight":{
            "description":"Actual height of the platform or floor above the ground or the rail.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgHeight":{
            "description":"When empty, indicates the height from Top of Rail to the Center of Gravity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckTypeGid":{
            "description":"An GID to define the Truck Type to Categorize the Equipment Group.",
            "type":"string"
        },
        "pullingLength":{
            "description":"Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"The tare weight of the equipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgLength":{
            "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgWidth":{
            "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCenterLength":{
            "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCount":{
            "description":"The total number of trucks/bogies on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "totalAxleCount":{
            "description":"The total number of axles on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "maxAxleWeight":{
            "description":"Maximum allowed axle weight. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "equipmentTypes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.equipmentTypes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "compartments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.compartments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packagedItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.packagedItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipUnitSpecCompatibilities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.shipUnitSpecCompatibilities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "axleLoadingWeights":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.axleLoadingWeights"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "obstructions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.obstructions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vehicleTypeCompatibilities":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.vehicleTypeCompatibilities"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : axleLoadingWeights

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.axleLoadingWeights"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : compartments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.compartments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : doorHeight

Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.

Match All

Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.

Show Source

• object amountType

{
    "description":"Height of the door on the equipment group. Used to check against the height of a ship unit. In many cases, the height of the door is not equal to the actual height of the equipment, which can lead to loading limitations. Use the Door Height field to specify the height of the door so the planning logic can take this under consideration.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : effectiveVolume

The capacity for the equipment.

Match All

The capacity for the equipment.

Show Source

• object amountType

{
    "description":"The capacity for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : effectiveWeight

The weight of the equipment.

Match All

The weight of the equipment.

Show Source

• object amountType

{
    "description":"The weight of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgHeight

When empty, indicates the height from Top of Rail to the Center of Gravity.

Match All

When empty, indicates the height from Top of Rail to the Center of Gravity.

Show Source

• object amountType

{
    "description":"When empty, indicates the height from Top of Rail to the Center of Gravity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgLength

When empty, length wise position of center of gravity from the equipment bottom leftmost corner.

Match All

When empty, length wise position of center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgWidth

When empty, width wise position of center of gravity from the equipment bottom leftmost corner.

Match All

When empty, width wise position of center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipMaxGrossWt

The maximum permissible weight of the equipment and the load.

Match All

The maximum permissible weight of the equipment and the load.

Show Source

• object amountType

{
    "description":"The maximum permissible weight of the equipment and the load.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentTypes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.equipmentTypes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exteriorHeight

Stores the exterior height of the equipment group.

Match All

Stores the exterior height of the equipment group.

Show Source

• object amountType

{
    "description":"Stores the exterior height of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : exteriorLength

Stores the exterior length of the equipment group.

Match All

Stores the exterior length of the equipment group.

Show Source

• object amountType

{
    "description":"Stores the exterior length of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : exteriorWidth

Stores the width length of the equipment group.

Match All

Stores the width length of the equipment group.

Show Source

• object amountType

{
    "description":"Stores the width length of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : floorHeight

Actual height of the platform or floor above the ground or the rail.

Match All

Actual height of the platform or floor above the ground or the rail.

Show Source

• object amountType

{
    "description":"Actual height of the platform or floor above the ground or the rail.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : height

The height of the equipment group.

Match All

The height of the equipment group.

Show Source

• object amountType

{
    "description":"The height of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : length

The length of the equipment group.

Match All

The length of the equipment group.

Show Source

• object amountType

{
    "description":"The length of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxAxleWeight

Maximum allowed axle weight. Applicable only to rail cars.

Match All

Maximum allowed axle weight. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Maximum allowed axle weight. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxHeightPerUnit

Stores the maximum per ship unit height allowed.

Match All

Stores the maximum per ship unit height allowed.

Show Source

• object amountType

{
    "description":"Stores the maximum per ship unit height allowed. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxLengthPerUnit

Stores the maximum per ship unit length allowed.

Match All

Stores the maximum per ship unit length allowed.

Show Source

• object amountType

{
    "description":"Stores the maximum per ship unit length allowed. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxLhsWeight

The max weight allowed on the left hand side of the equipment.

Match All

The max weight allowed on the left hand side of the equipment.

Show Source

• object amountType

{
    "description":"The max weight allowed on the left hand side of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxRhsWeight

The max weight allowed on the right hand side of the equipment.

Match All

The max weight allowed on the right hand side of the equipment.

Show Source

• object amountType

{
    "description":"The max weight allowed on the right hand side of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxSideWeightDiff

The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.

Match All

The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.

Show Source

• object amountType

{
    "description":"The max weight difference allowed between two sides (left and right) of the equipment to prevent load imbalance.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWidthPerUnit

Stores the maximum per ship unit width allowed.

Match All

Stores the maximum per ship unit width allowed.

Show Source

• object amountType

{
    "description":"Stores the maximum per ship unit width allowed. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : obstructions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.obstructions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : packagedItems

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.packagedItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : pullingLength

Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.

Match All

Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.

Show Source

• object amountType

{
    "description":"Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : shipUnitSpecCompatibilities

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.shipUnitSpecCompatibilities"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tareWeight

The tare weight of the equipment group.

Match All

The tare weight of the equipment group.

Show Source

• object amountType

{
    "description":"The tare weight of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckCenterLength

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Match All

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : vehicleTypeCompatibilities

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.vehicleTypeCompatibilities"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : width

The width of the equipment group.

Match All

The width of the equipment group.

Show Source

• object amountType

{
    "description":"The width of the equipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.axleLoadingWeights"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• axleDistance: axleDistance
  The distance from the nose of the equipment where the max weight can be loaded.
• axleName: string
  User-specified name for the axle where the distance and max weight are defined, such as front axle or rear axle.
• axleSequenceNo: number (int32)
  The axle sequence number.
• domainName: string
  Axle distance in the base unit of measure.
• links: array links
  Read Only: true
• maxWeight: maxWeight
  The max loading weight allowed.

{
    "properties":{
        "axleSequenceNo":{
            "description":"The axle sequence number.",
            "type":"number",
            "format":"int32"
        },
        "axleName":{
            "description":"User-specified name for the axle where the distance and max weight are defined, such as front axle or rear axle.",
            "type":"string"
        },
        "axleDistance":{
            "description":"The distance from the nose of the equipment where the max weight can be loaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWeight":{
            "description":"The max loading weight allowed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Axle distance in the base unit of measure.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : axleDistance

The distance from the nose of the equipment where the max weight can be loaded.

Match All

The distance from the nose of the equipment where the max weight can be loaded.

Show Source

• object amountType

{
    "description":"The distance from the nose of the equipment where the max weight can be loaded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxWeight

The max loading weight allowed.

Match All

The max loading weight allowed.

Show Source

• object amountType

{
    "description":"The max loading weight allowed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.compartments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• allowCommodityMixing: boolean
  Specifies if different commodity items can be shipped in the same compartment in an equipment group. Valid values are Y for yes and N for no.
• commodityGid: string
  Commodity that is compatible with the compartment.
• compartmentNum: number (int32)
  Identifies the compartment by number.
• compartmentTypeGid: string
  A GID to define the compartment type.
• curveGid: string
  The curve function for the roof of the compartment.
• domainName: string
  Database domain where this data is stored.
• doorHeight: doorHeight
  Defines the height of the door for the compartment.
• hasMeter: boolean
  Indicates if the compartment has METER or not (The METER is a device that is used the measure how much product is discharged at any given stop).
• height: height
  The height of the equipment group compartment.
• isBulk: boolean
  Indicates if it is a BULK. If Y then BULK If N then PACKAGED.
• length: length
  The length of the equipment group compartment.
• lengthFwdOffset: lengthFwdOffset
  Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.
• links: array links
  Read Only: true
• maxMetric3: number (double)
  N/A
• maxMetric4: number (double)
  N/A
• maxVolume: maxVolume
  The maximum capacity for the equipment group compartment.
• maxWeight: maxWeight
  The maximum weight for the equipment group compartment.
• packagedItems: packagedItems
• startHeightPosition: startHeightPosition
  Defines the starting position for the compartment, height wise.
• startLengthPosition: startLengthPosition
  Defines the starting position for the compartment length wise.
• startWidthPosition: startWidthPosition
  Defines the starting position for the compartment, width wise.
• temperatureControlGid: string
  The GID to define the temperature controls value for the commodity.
• width: width
  The width of the equipment group compartment.
• widthOffset: widthOffset
  Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.

{
    "properties":{
        "compartmentNum":{
            "description":"Identifies the compartment by number.",
            "type":"number",
            "format":"int32"
        },
        "maxWeight":{
            "description":"The maximum weight for the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"The maximum capacity for the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxMetric3":{
            "description":"N/A",
            "type":"number",
            "format":"double"
        },
        "maxMetric4":{
            "description":"N/A",
            "type":"number",
            "format":"double"
        },
        "length":{
            "description":"The length of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the equipment group compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "temperatureControlGid":{
            "description":"The GID to define the temperature controls value for the commodity.",
            "type":"string"
        },
        "allowCommodityMixing":{
            "description":"Specifies if different commodity items can be shipped in the same compartment in an equipment group. Valid values are Y for yes and N for no.",
            "type":"boolean"
        },
        "doorHeight":{
            "description":"Defines the height of the door for the compartment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "curveGid":{
            "description":"The curve function for the roof of the compartment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "startLengthPosition":{
            "description":"Defines the starting position for the compartment length wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startWidthPosition":{
            "description":"Defines the starting position for the compartment, width wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startHeightPosition":{
            "description":"Defines the starting position for the compartment, height wise.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "compartmentTypeGid":{
            "description":"A GID to define the compartment type.",
            "type":"string"
        },
        "hasMeter":{
            "description":"Indicates if the compartment has METER or not (The METER is a device that is used the measure how much product is discharged at any given stop).",
            "type":"boolean"
        },
        "commodityGid":{
            "description":"Commodity that is compatible with the compartment.",
            "type":"string"
        },
        "isBulk":{
            "description":"Indicates if it is a BULK. If Y then BULK If N then PACKAGED.",
            "type":"boolean"
        },
        "widthOffset":{
            "description":"Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "lengthFwdOffset":{
            "description":"Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packagedItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentGroups.compartments.packagedItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : doorHeight

Defines the height of the door for the compartment.

Match All

Defines the height of the door for the compartment.

Show Source

• object amountType

{
    "description":"Defines the height of the door for the compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : height

The height of the equipment group compartment.

Match All

The height of the equipment group compartment.

Show Source

• object amountType

{
    "description":"The height of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

The length of the equipment group compartment.

Match All

The length of the equipment group compartment.

Show Source

• object amountType

{
    "description":"The length of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : lengthFwdOffset

Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.

Match All

Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.

Show Source

• object amountType

{
    "description":"Offset by which the compartment needs to be shifted FORWARD lengthwise to get the OUT OF GAUGE envelope.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxVolume

The maximum capacity for the equipment group compartment.

Match All

The maximum capacity for the equipment group compartment.

Show Source

• object amountType

{
    "description":"The maximum capacity for the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

The maximum weight for the equipment group compartment.

Match All

The maximum weight for the equipment group compartment.

Show Source

• object amountType

{
    "description":"The maximum weight for the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packagedItems

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentGroups.compartments.packagedItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : startHeightPosition

Defines the starting position for the compartment, height wise.

Match All

Defines the starting position for the compartment, height wise.

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment, height wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startLengthPosition

Defines the starting position for the compartment length wise.

Match All

Defines the starting position for the compartment length wise.

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment length wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startWidthPosition

Defines the starting position for the compartment, width wise.

Match All

Defines the starting position for the compartment, width wise.

Show Source

• object amountType

{
    "description":"Defines the starting position for the compartment, width wise.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width of the equipment group compartment.

Match All

The width of the equipment group compartment.

Show Source

• object amountType

{
    "description":"The width of the equipment group compartment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : widthOffset

Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.

Match All

Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.

Show Source

• object amountType

{
    "description":"Offset by which the compartment needs to be shifted widthwise to get the OUT OF GAUGE envelope.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.compartments.packagedItems"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item that is linked to the compartment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "packagedItemGid":{
            "description":"The packaged item that is linked to the compartment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : packagedItems

Type: object

Show Source

• accessorials: accessorials
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• bbHandlingType: string
  Indicates the Batch Balancer handling type for the packaged item. Valid handling types are conveyable, non-conveyable, and repack. Batch Balancer logic uses this info to determine potential batches for order release line assignment in the event an order release needs to be split across multiple batches.
• bulkMixingFamilyGid: string
  Indicates the bulk mixing family the packaged item belongs to.
• categoryGid: string
  The GID for the packaged item category.
• compartmentTypeProfGid: string
  Compartment type profile attached to the packaged item.
• coreDiameter: coreDiameter
  For cylindrical objects, this defines the diameter of the core.
• description: string
  Packaged item free form text field for the description. For example, a case of soda.
• domainName: string
  Database domain where this data is stored.
• equipmentRefUnits: equipmentRefUnits
• hazmatPackageTypeGid: string
  The GID for the hazmat package type. This field can be used to give the packaged item a special description. If you are defining a hazardous material, use this field to describe it.
• incrNestingHeight: incrNestingHeight
  Specifies the incremental nesting height for the PI
• innerPackCount: number (double)
  The count for the number of items in the inner pack.
• innerPackPackagingUnitGid: string
  The packaging unit related to the count for the number of items in the inner pack.
• innerPackSize: number (double)
  Indicates the inner pack count or size. The inner pack size unit of measure qualified the value entered here.
• innerPackSizeUomCode: string
  Unit of measure for the pack size entry. Packaged item = case of soda - inner pack = six pack inner pack size = 4, inner pack unit of measure = six pack.
• insertDate: insertDate
  Read Only: true

  insert date
• isAllowMixedFreight: boolean
  Allow mixed freight should be selected if the packaged item can be packed into a ship unit with other mixable packaged items.
• isDefaultPackaging: boolean
  Check box indicating if the information entered is the default packaging for this item.
• isHazardous: boolean
  Check box indicating if the information entered is the packaged item is considered hazardous.
• isNestable: boolean
  Specifies if the packaged item is nestable or not
• item: item
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itemGid: string
  The GID for the item. Product without the packaging.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• loadConfigRuleRank: number (int32)
  During 3D loading of mixed items, the packaged item with the highest rank will be used to find the matching stackability rule and load config rule.
• packagedItemGid: string
  The GID for the packaged item.
• packagedItemTypeGid: string
  Type of packaged item.
• packagedItemXid: string
  The XID for the packaged item.
• packageRefUnits: packageRefUnits
• packageShipUnitWeight: packageShipUnitWeight
  The weight of the ship unit.
• packageSuDiameter: packageSuDiameter
  Packaged ship unit diameter.
• packageSuHeight: packageSuHeight
  Package ship unit ship unit height.
• packageSuLength: packageSuLength
  Package ship unit ship unit length.
• packageSuVolume: packageSuVolume
  Packaged ship unit volume.
• packageSuWidth: packageSuWidth
  Packaged ship unit width.
• packagingUnitGid: string
  The GID for the packaging unit.
• parcelPacktype: string
  Parcel package type.
• priority: number (int32)
  This column defines the priority associated with an packaged item.
• pruUsages: pruUsages
• refnums: refnums
• thuProfileGid: string
  Defines all valid THUs the PI can be packed into.
• tiHis: tiHis
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "packagedItemGid":{
            "description":"The GID for the packaged item.",
            "type":"string"
        },
        "packagedItemXid":{
            "description":"The XID for the packaged item.",
            "type":"string"
        },
        "description":{
            "description":"Packaged item free form text field for the description. For example, a case of soda.",
            "type":"string"
        },
        "itemGid":{
            "description":"The GID for the item. Product without the packaging. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "item":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "hazmatPackageTypeGid":{
            "description":"The GID for the hazmat package type. This field can be used to give the packaged item a special description. If you are defining a hazardous material, use this field to describe it.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit. ",
            "type":"string"
        },
        "packageShipUnitWeight":{
            "description":"The weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "innerPackCount":{
            "description":"The count for the number of items in the inner pack.",
            "type":"number",
            "format":"double"
        },
        "innerPackPackagingUnitGid":{
            "description":"The packaging unit related to the count for the number of items in the inner pack.",
            "type":"string"
        },
        "innerPackSize":{
            "description":"Indicates the inner pack count or size. The inner pack size unit of measure qualified the value entered here.",
            "type":"number",
            "format":"double"
        },
        "innerPackSizeUomCode":{
            "description":"Unit of measure for the pack size entry. Packaged item = case of soda - inner pack = six pack inner pack size = 4, inner pack unit of measure = six pack.",
            "type":"string"
        },
        "packageSuVolume":{
            "description":"Packaged ship unit volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuLength":{
            "description":"Package ship unit ship unit length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuWidth":{
            "description":"Packaged ship unit width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuHeight":{
            "description":"Package ship unit ship unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isDefaultPackaging":{
            "description":"Check box indicating if the information entered is the default packaging for this item. ",
            "type":"boolean"
        },
        "isHazardous":{
            "description":"Check box indicating if the information entered is the packaged item is considered hazardous.",
            "type":"boolean"
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuDiameter":{
            "description":"Packaged ship unit diameter.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bbHandlingType":{
            "description":"Indicates the Batch Balancer handling type for the packaged item. Valid handling types are conveyable, non-conveyable, and repack. Batch Balancer logic uses this info to determine potential batches for order release line assignment in the event an order release needs to be split across multiple batches.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagedItemTypeGid":{
            "description":"Type of packaged item.",
            "type":"string"
        },
        "loadConfigRuleRank":{
            "description":"During 3D loading of mixed items, the packaged item with the highest rank will be used to find the matching stackability rule and load config rule.",
            "type":"number",
            "format":"int32"
        },
        "thuProfileGid":{
            "description":"Defines all valid THUs the PI can be packed into.",
            "type":"string"
        },
        "parcelPacktype":{
            "description":"Parcel package type.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isAllowMixedFreight":{
            "description":"Allow mixed freight should be selected if the packaged item can be packed into a ship unit with other mixable packaged items.",
            "type":"boolean"
        },
        "bulkMixingFamilyGid":{
            "description":"Indicates the bulk mixing family the packaged item belongs to.",
            "type":"string"
        },
        "compartmentTypeProfGid":{
            "description":"Compartment type profile attached to the packaged item.",
            "type":"string"
        },
        "categoryGid":{
            "description":"The GID for the packaged item category.",
            "type":"string"
        },
        "priority":{
            "description":"This column defines the priority associated with an packaged item.",
            "type":"number",
            "format":"int32"
        },
        "isNestable":{
            "description":"Specifies if the packaged item is nestable or not",
            "type":"boolean"
        },
        "incrNestingHeight":{
            "description":"Specifies the incremental nesting height for the PI",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "pruUsages":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.pruUsages"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "tiHis":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.tiHis"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packageRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.packageRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/packagedItems.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : coreDiameter

For cylindrical objects, this defines the diameter of the core.

Match All

For cylindrical objects, this defines the diameter of the core.

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the core.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/packagedItems.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : incrNestingHeight

Specifies the incremental nesting height for the PI

Match All

Specifies the incremental nesting height for the PI

Show Source

• object amountType

{
    "description":"Specifies the incremental nesting height for the PI",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : item

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packageRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/packagedItems.packageRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : packageShipUnitWeight

The weight of the ship unit.

Match All

The weight of the ship unit.

Show Source

• object amountType

{
    "description":"The weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuDiameter

Packaged ship unit diameter.

Match All

Packaged ship unit diameter.

Show Source

• object amountType

{
    "description":"Packaged ship unit diameter.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuHeight

Package ship unit ship unit height.

Match All

Package ship unit ship unit height.

Show Source

• object amountType

{
    "description":"Package ship unit ship unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuLength

Package ship unit ship unit length.

Match All

Package ship unit ship unit length.

Show Source

• object amountType

{
    "description":"Package ship unit ship unit length.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuVolume

Packaged ship unit volume.

Match All

Packaged ship unit volume.

Show Source

• object amountType

{
    "description":"Packaged ship unit volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuWidth

Packaged ship unit width.

Match All

Packaged ship unit width.

Show Source

• object amountType

{
    "description":"Packaged ship unit width.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pruUsages

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/packagedItems.pruUsages"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/packagedItems.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tiHis

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/packagedItems.tiHis"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.accessorials

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItems.accessorials

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code GID.
• domainName: string
  No description.
• links: array links
  Read Only: true
• remarks: remarks

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The accessorial code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/packagedItems.accessorials.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/packagedItems.accessorials.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.accessorials.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.accessorials.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItems.accessorials.remarks

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The remark sequence associated with the packaged item
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence associated with the packaged item",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.equipmentRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.equipmentRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItems.equipmentRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  ERU for the packaged item
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of reference units per package for ERU.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"ERU for the packaged item",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The number of reference units per package for ERU.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorials: accessorials
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• boms: boms
• brandName: string
  The brand name is an informational text field and allows you to enter the brand name for an item.
• classifications: classifications
• commodityGid: string
  The GID for the commodity.
• countryOfOriginGid: string
  Specifies the country of origin for the item
• countryOfOrigins: countryOfOrigins
• description: string
  A description of the item being shipped.
• descriptions: descriptions
• documents: documents
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date is used to set the start time window for when an item should be used on an order.
• expirationDate: expirationDate
  The expiration date is used to set the end time window for when an item should be used on an order.
• features: features
• htsGid: string
  The GID for the Harmonized Tariff System (HTS).
• iataScrCodeGid: string
  Legacy field that was used to capture the IATA source code. This fields is no longer used for visible on the UI.
• indicator: string
  Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object.
• insertDate: insertDate
  Read Only: true

  insert date
• isDrawback: boolean
  Legacy field used to identify items that were to be tracked for duty drawback opportunities. This field is no longer used or visible on the UI.
• isTemplate: boolean
  Check box indicating whether or not this item record will be used as an item template or not.
• itemGid: string
  The GID for the item.
• itemName: string
  Text for the name of the item.
• itemOrigins: itemOrigins
• itemTemplateGid: string
  Item template gid indicates the last item template applied on item
• itemTypeGid: string
  Specifies the item type for the item
• itemValueSets: itemValueSets
• itemXid: string
  The XID for the item.
• links: array links
  Read Only: true
• manufacturedCountryCodeGid: string
  Legacy field used to identify an items manufactured country code. GTM now supports the concept of manufactured country code in a more robust fashion. This field is no longer used or visible on the UI.
• nmfcArticleGid: string
  The GID for the National Motor Freight Classification (NMFC) article/item number. The NMFC article refers to the NMFC's standard grouping of items, for example the article Brick(s): Thermal energy storage, ceramic is identified with the item number of 32270. The intended use for this table is to assign the item number related to the NMFC article as the ID for the NMFC Article XID. Note that within the system the NMFC article and the relationship between the article and the NMFC freight class are for information only.
• nmfcClassGid: string
  The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc.
• packagedItems: packagedItems
• partnerItems: partnerItems
• partnerSites: partnerSites
• pricePerUnit: pricePerUnit
  The price per unit based on the unit of measure selected.
• priority: number (int32)
  The priority associated with an item.
• prodClassTemplateGid: string
  Product Class template gid indicates the last classification template applied on the item
• refnums: refnums
• relationships: relationships
• remarks: remarks
• reqdocDocReviews: reqdocDocReviews
• reqdocDocs: reqdocDocs
• reqdocReviewers: reqdocReviewers
• reqdocs: reqdocs
• reqdocStatuses: reqdocStatuses
• reqdocSubscribers: reqdocSubscribers
• reqdocTexts: reqdocTexts
• sitcGid: string
  The GID for the Standard International Trade Classification (SITC).
• specialServices: specialServices
• statuses: statuses
• stccGid: string
  The GID for the Standard Commodity Code (STCC).
• texts: texts
• udcClassificationListGid: string
  List of User Defined commodities for item.
• unitOfMeasure: string
  The price per unit of measure.
• uomConversions: uomConversions
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefinedCommodityGid: string
  The GID for the user-defined commodity.
• whollyOriginating: string
  Indicates if the item is wholly originating.

{
    "properties":{
        "itemGid":{
            "description":"The GID for the item.",
            "type":"string"
        },
        "itemXid":{
            "description":"The XID for the item.",
            "type":"string"
        },
        "itemName":{
            "description":"Text for the name of the item.",
            "type":"string"
        },
        "commodityGid":{
            "description":"The GID for the commodity.",
            "type":"string"
        },
        "nmfcArticleGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC) article/item number. The NMFC article refers to the NMFC's standard grouping of items, for example the article Brick(s): Thermal energy storage, ceramic is identified with the item number of 32270. The intended use for this table is to assign the item number related to the NMFC article as the ID for the NMFC Article XID. Note that within the system the NMFC article and the relationship between the article and the NMFC freight class are for information only.",
            "type":"string"
        },
        "nmfcClassGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc. ",
            "type":"string"
        },
        "stccGid":{
            "description":"The GID for the Standard Commodity Code (STCC).",
            "type":"string"
        },
        "htsGid":{
            "description":"The GID for the Harmonized Tariff System (HTS).",
            "type":"string"
        },
        "sitcGid":{
            "description":"The GID for the Standard International Trade Classification (SITC).",
            "type":"string"
        },
        "description":{
            "description":"A description of the item being shipped.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for the user-defined commodity.",
            "type":"string"
        },
        "udcClassificationListGid":{
            "description":"List of User Defined commodities for item.",
            "type":"string"
        },
        "brandName":{
            "description":"The brand name is an informational text field and allows you to enter the brand name for an item.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date is used to set the start time window for when an item should be used on an order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date is used to set the end time window for when an item should be used on an order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "manufacturedCountryCodeGid":{
            "description":"Legacy field used to identify an items manufactured country code. GTM now supports the concept of manufactured country code in a more robust fashion. This field is no longer used or visible on the UI.",
            "type":"string"
        },
        "isDrawback":{
            "description":"Legacy field used to identify items that were to be tracked for duty drawback opportunities. This field is no longer used or visible on the UI.",
            "type":"boolean"
        },
        "iataScrCodeGid":{
            "description":"Legacy field that was used to capture the IATA source code. This fields is no longer used for visible on the UI.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "unitOfMeasure":{
            "description":"The price per unit of measure.",
            "type":"string"
        },
        "pricePerUnit":{
            "description":"The price per unit based on the unit of measure selected.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isTemplate":{
            "description":"Check box indicating whether or not this item record will be used as an item template or not.",
            "type":"boolean"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "indicator":{
            "description":"Indicators are icons that can be assigned to business objects that can be displayed in search Results pages and other lists to indicate the condition or state of a business object. You can use indicators to mark the history, status or any other condition of a business object. ",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "priority":{
            "description":"The priority associated with an item.",
            "type":"number",
            "format":"int32"
        },
        "itemTypeGid":{
            "description":"Specifies the item type for the item",
            "type":"string"
        },
        "countryOfOriginGid":{
            "description":"Specifies the country of origin for the item",
            "type":"string"
        },
        "itemTemplateGid":{
            "description":"Item template gid indicates the last item template applied on item",
            "type":"string"
        },
        "prodClassTemplateGid":{
            "description":"Product Class template gid indicates the last classification template applied on the item",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number",
            "type":"number",
            "format":"double"
        },
        "whollyOriginating":{
            "description":"Indicates if the item is wholly originating.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packagedItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocReviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocReviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocSubscribers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocSubscribers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocDocs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocTexts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocTexts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocStatuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocStatuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocDocReviews":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocReviews"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "relationships":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.relationships"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "boms":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.boms"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "features":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.features"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "descriptions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.descriptions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "uomConversions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.uomConversions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "classifications":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "countryOfOrigins":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.countryOfOrigins"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "itemOrigins":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "partnerItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "partnerSites":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerSites"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "itemValueSets":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : boms

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.boms"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : classifications

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : countryOfOrigins

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.countryOfOrigins"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : descriptions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.descriptions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date is used to set the start time window for when an item should be used on an order.

Match All

The effective date is used to set the start time window for when an item should be used on an order.

Show Source

• object dateType

{
    "description":"The effective date is used to set the start time window for when an item should be used on an order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date is used to set the end time window for when an item should be used on an order.

Match All

The expiration date is used to set the end time window for when an item should be used on an order.

Show Source

• object dateType

{
    "description":"The expiration date is used to set the end time window for when an item should be used on an order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : features

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.features"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : itemOrigins

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : itemValueSets

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItems

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : partnerItems

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : partnerSites

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerSites"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : pricePerUnit

The price per unit based on the unit of measure selected.

Match All

The price per unit based on the unit of measure selected.

Show Source

• object currencyType

{
    "description":"The price per unit based on the unit of measure selected.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : relationships

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.relationships"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocDocReviews

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocReviews"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocDocs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocReviewers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocReviewers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocStatuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocStatuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocSubscribers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocSubscribers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocTexts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocTexts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : uomConversions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.uomConversions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial code.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The GID for the accessorial code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.boms"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• childItemCount: number (int32)
  The number of child items in the parent item's BOM.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• parentItem: parentItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentItemGid: string
  The GID for the item that is having the item BOM added, updated, or removed.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "parentItemGid":{
            "description":"The GID for the item that is having the item BOM added, updated, or removed. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "childItemCount":{
            "description":"The number of child items in the parent item's BOM.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : parentItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• approverNotes: string
  Approver notes is a notes field is to capture any comments the classification approver may have related to their approval of this classification type and code to this particular item.
• attribute1: string
  No description.
• attribute10: string
  No description.
• attribute11: string
  No description.
• attribute12: string
  No description.
• attribute13: string
  No description.
• attribute14: string
  No description.
• attribute15: string
  No description.
• attribute16: string
  No description.
• attribute17: string
  No description.
• attribute18: string
  No description.
• attribute19: string
  No description.
• attribute2: string
  No description.
• attribute20: string
  No description.
• attribute3: string
  No description.
• attribute4: string
  No description.
• attribute5: string
  No description.
• attribute6: string
  No description.
• attribute7: string
  No description.
• attribute8: string
  No description.
• attribute9: string
  No description.
• attributeDate1: attributeDate1
  No description.
• attributeDate10: attributeDate10
  No description.
• attributeDate2: attributeDate2
  No description.
• attributeDate3: attributeDate3
  No description.
• attributeDate4: attributeDate4
  No description.
• attributeDate5: attributeDate5
  No description.
• attributeDate6: attributeDate6
  No description.
• attributeDate7: attributeDate7
  No description.
• attributeDate8: attributeDate8
  No description.
• attributeDate9: attributeDate9
  No description.
• attributeNumber1: number (double)
  No description.
• attributeNumber10: number (double)
  No description.
• attributeNumber2: number (double)
  No description.
• attributeNumber3: number (double)
  No description.
• attributeNumber4: number (double)
  No description.
• attributeNumber5: number (double)
  No description.
• attributeNumber6: number (double)
  No description.
• attributeNumber7: number (double)
  No description.
• attributeNumber8: number (double)
  No description.
• attributeNumber9: number (double)
  No description.
• bindingRulingEffectiveDate: bindingRulingEffectiveDate
  Effective date of the binding ruling
• bindingRulingExpirationDate: bindingRulingExpirationDate
  Indicates the binding rule expiration date.
• bindingRulingNumber: string
  Binding ruling number to justify classification
• classificationCode: string
  Classification code for an item.
• classificationDate: classificationDate
  Date when classification is done
• classificationNotes: string
  Classification notes is a notes field available to enter any hints or insights into the item classification reasoning.
• classificationStatus: string
  Classification status is a read only field that reflects the status of the product classification. For example, Classification Created, Classification Approved.
• classificationUser: string
  User who does classification
• codeAttributes: codeAttributes
• customsDescription: string
  Customs description is a description field available to enter any hints or insights into the item customs reasoning.
• domainName: string
  Database domain where this data is stored.
• eligibilityScreeningDate: eligibilityScreeningDate
  Date when eligibility screening is done
• eligibilityScreeningUser: string
  User who does eligibility screening
• gtmItemClassificationGid: string
  A GID field available to enter any hints or insights into the item gtm_item_classification reasoning.
• gtmItemClassificationXid: string
  An XID field available to enter any hints or insights into the item gtm_item_classification reasoning.
• gtmProdClassCodeGid: string
  The GID for the product classification code that is being added, updated, or removed for the item. The product classification code is qualified/filtered by the product classification type.
• gtmProdClassPurposeGid: string
  Product Classification Purpose
• gtmProdClassTypeGid: string
  The GID for the product classification type that is being added, updated, or removed. The product classification type qualifies/filters the values of the product classification code being added. For example the product classification type of HTS US is related to the product classification codes for the Harmonized Tariff Schedule of the United States. GTM will check to see if the product classification code is valid and matches the selected classification type.
• gtmTariffRoiGid: string
  Unique identifier for the gtm tariff rules of interpretation used to justify classification
• links: array links
  Read Only: true
• refnums: refnums
• remarks: remarks
• reviewDate: reviewDate
  Date when review is done
• reviewUser: string
  User who reviews classification

{
    "properties":{
        "gtmItemClassificationGid":{
            "description":"A GID field available to enter any hints or insights into the item gtm_item_classification reasoning.",
            "type":"string"
        },
        "gtmProdClassTypeGid":{
            "description":"The GID for the product classification type that is being added, updated, or removed. The product classification type qualifies/filters the values of the product classification code being added. For example the product classification type of HTS US is related to the product classification codes for the Harmonized Tariff Schedule of the United States. GTM will check to see if the product classification code is valid and matches the selected classification type.",
            "type":"string"
        },
        "gtmProdClassCodeGid":{
            "description":"The GID for the product classification code that is being added, updated, or removed for the item. The product classification code is qualified/filtered by the product classification type.",
            "type":"string"
        },
        "classificationStatus":{
            "description":"Classification status is a read only field that reflects the status of the product classification. For example, Classification Created, Classification Approved.",
            "type":"string"
        },
        "classificationNotes":{
            "description":"Classification notes is a notes field available to enter any hints or insights into the item classification reasoning.",
            "type":"string"
        },
        "approverNotes":{
            "description":"Approver notes is a notes field is to capture any comments the classification approver may have related to their approval of this classification type and code to this particular item.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "gtmItemClassificationXid":{
            "description":"An XID field available to enter any hints or insights into the item gtm_item_classification reasoning.",
            "type":"string"
        },
        "customsDescription":{
            "description":"Customs description is a description field available to enter any hints or insights into the item customs reasoning.",
            "type":"string"
        },
        "attribute1":{
            "description":"No description.",
            "type":"string"
        },
        "attribute2":{
            "description":"No description.",
            "type":"string"
        },
        "attribute3":{
            "description":"No description.",
            "type":"string"
        },
        "attribute4":{
            "description":"No description.",
            "type":"string"
        },
        "attribute5":{
            "description":"No description.",
            "type":"string"
        },
        "attribute6":{
            "description":"No description.",
            "type":"string"
        },
        "attribute7":{
            "description":"No description.",
            "type":"string"
        },
        "attribute8":{
            "description":"No description.",
            "type":"string"
        },
        "attribute9":{
            "description":"No description.",
            "type":"string"
        },
        "attribute10":{
            "description":"No description.",
            "type":"string"
        },
        "attribute11":{
            "description":"No description.",
            "type":"string"
        },
        "attribute12":{
            "description":"No description.",
            "type":"string"
        },
        "attribute13":{
            "description":"No description.",
            "type":"string"
        },
        "attribute14":{
            "description":"No description.",
            "type":"string"
        },
        "attribute15":{
            "description":"No description.",
            "type":"string"
        },
        "attribute16":{
            "description":"No description.",
            "type":"string"
        },
        "attribute17":{
            "description":"No description.",
            "type":"string"
        },
        "attribute18":{
            "description":"No description.",
            "type":"string"
        },
        "attribute19":{
            "description":"No description.",
            "type":"string"
        },
        "attribute20":{
            "description":"No description.",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "bindingRulingNumber":{
            "description":"Binding ruling number to justify classification",
            "type":"string"
        },
        "bindingRulingEffectiveDate":{
            "description":"Effective date of the binding ruling",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "classificationUser":{
            "description":"User who does classification",
            "type":"string"
        },
        "classificationDate":{
            "description":"Date when classification is done",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "reviewUser":{
            "description":"User who reviews classification",
            "type":"string"
        },
        "reviewDate":{
            "description":"Date when review is done",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "eligibilityScreeningUser":{
            "description":"User who does eligibility screening",
            "type":"string"
        },
        "eligibilityScreeningDate":{
            "description":"Date when eligibility screening is done",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "gtmTariffRoiGid":{
            "description":"Unique identifier for the gtm tariff rules of interpretation used to justify classification",
            "type":"string"
        },
        "bindingRulingExpirationDate":{
            "description":"Indicates the binding rule expiration date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "gtmProdClassPurposeGid":{
            "description":"Product Classification Purpose",
            "type":"string"
        },
        "classificationCode":{
            "description":"Classification code for an item.",
            "type":"string"
        },
        "codeAttributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.codeAttributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : bindingRulingEffectiveDate

Effective date of the binding ruling

Match All

Effective date of the binding ruling

Show Source

• object dateType

{
    "description":"Effective date of the binding ruling",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : bindingRulingExpirationDate

Indicates the binding rule expiration date.

Match All

Indicates the binding rule expiration date.

Show Source

• object dateType

{
    "description":"Indicates the binding rule expiration date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : classificationDate

Date when classification is done

Match All

Date when classification is done

Show Source

• object dateTimeType

{
    "description":"Date when classification is done",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : codeAttributes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.codeAttributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eligibilityScreeningDate

Date when eligibility screening is done

Match All

Date when eligibility screening is done

Show Source

• object dateTimeType

{
    "description":"Date when eligibility screening is done",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reviewDate

Date when review is done

Match All

Date when review is done

Show Source

• object dateTimeType

{
    "description":"Date when review is done",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.classifications.codeAttributes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.codeAttributes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : itemsWithProdClassCodeGid.classifications.codeAttributes

Type: object

Show Source

• attributeDescription: string
  The attribute description of the GTM product classification code attribute that is being added, updated, or deleted. The Description field has been configured to display all associated license control and license exception description attributes.
• attributeName: string
  The attribute name of the GTM product classification code attribute that is being added, updated, or deleted.
• attributeSequence: number (int64)
  The sequence number for the GTM product classification code attribute that is being added, updated, or deleted.
• attributeValue: string
  The attribute value - qualified by the attribute name - of the GTM product classification code attribute that is being added, updated, or deleted.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "attributeSequence":{
            "description":"The sequence number for the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"number",
            "format":"int64"
        },
        "attributeName":{
            "description":"The attribute name of the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"string"
        },
        "attributeValue":{
            "description":"The attribute value - qualified by the attribute name -  of the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attributeDescription":{
            "description":"The attribute description of the GTM product classification code attribute that is being added, updated, or deleted. The Description field has been configured to display all associated license control and license exception description attributes.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• gtmItemClassRefnumQualGid: string
  The GID for the item classification reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The value of the reference number.

{
    "properties":{
        "gtmItemClassRefnumQualGid":{
            "description":"The GID for the item classification reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The value of the reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.classifications.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier.
• remarkSequence: number (int64)
  The sequence number for the item classification remark.
• remarkText: string
  The text of the remark about the item classification.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the item classification remark.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark about the item classification.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.countryOfOrigins"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• countryOfOriginGid: string
  Country code of the country of origin related to this supplier's source for this item. May be the two or three digit ISO country code depending on which option has been selected.
• domainName: string
  Database domain where this data is stored.
• isDefault: boolean
  Check box indicating - in the case of multiple country of origin entries for a supplier - which record is the default/assumed country of origin.
• links: array links
  Read Only: true
• manufacturingCountryGid: string
  Country code for the country of manufacturing related to this supplier's manufacturing of this item. May be the two or three digit ISO country code depending on which option has been selected.
• manufacturingDesc: string
  Supplier's description for this item.
• manufacturingPartNo: string
  Supplier's part number for this item.
• supplierSite: supplierSite
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• supplierSiteGid: string
  The GID for the supplier's party identification for where this item is sourced for this supplier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "supplierSiteGid":{
            "description":"The GID for the supplier's party identification for where this item is sourced for this supplier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "supplierSite":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "countryOfOriginGid":{
            "description":"Country code of the country of origin related to this supplier's source for this item. May be the two or three digit ISO country code depending on which option has been selected.",
            "type":"string"
        },
        "manufacturingCountryGid":{
            "description":"Country code for the country of manufacturing related to this supplier's manufacturing of this item. May be the two or three digit ISO country code depending on which option has been selected.",
            "type":"string"
        },
        "isDefault":{
            "description":"Check box indicating - in the case of multiple country of origin entries for a supplier - which record is the default/assumed country of origin.",
            "type":"boolean"
        },
        "manufacturingPartNo":{
            "description":"Supplier's part number for this item.",
            "type":"string"
        },
        "manufacturingDesc":{
            "description":"Supplier's description for this item.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : supplierSite

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property supplierSiteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.descriptions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• description: string
  Description text.
• domainName: string
  Database domain where this data is stored.
• gtmLanguageGid: string
  The GID for the country that is being used to qualify the language associated with the description.
• links: array links
  Read Only: true
• seqNo: number (double)
  Internal sequence number for the description.

{
    "properties":{
        "seqNo":{
            "description":"Internal sequence number for the description.",
            "type":"number",
            "format":"double"
        },
        "description":{
            "description":"Description text.",
            "type":"string"
        },
        "gtmLanguageGid":{
            "description":"The GID for the country that is being used to qualify the language associated with the description. ",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : itemsWithProdClassCodeGid.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.features"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for this feature.
• expirationDate: expirationDate
  The expiration date for the feature.
• itemFeatureQualGid: string
  The GID for the item feature qualifier/attribute that is used to identify the feature. For example, color.
• itemFeatureValue: string
  The value qualified by the feature qualifier. For example, item feature qualifier = color, then item feature value = red.
• links: array links
  Read Only: true

{
    "properties":{
        "itemFeatureQualGid":{
            "description":"The GID for the item feature qualifier/attribute  that is used to identify the feature.  For example, color.",
            "type":"string"
        },
        "itemFeatureValue":{
            "description":"The value qualified by the feature qualifier. For example, item feature qualifier = color, then item feature value = red.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for this feature.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date for the feature.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for this feature.

Match All

The effective date for this feature.

Show Source

• object dateType

{
    "description":"The effective date for this feature.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date for the feature.

Match All

The expiration date for the feature.

Show Source

• object dateType

{
    "description":"The expiration date for the feature.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• countryOfManufacture: string
  The country of manufacture for the item origin.
• countryOfOrigin: string
  The country of origin for the item origin.
• description: string
  Identifies the description of item by partner/partner site, inventory organization, and bill of material.
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for the item origin.
• expirationDate: expirationDate
  The expiration date for the item origin.
• gtmStructureGid: string
  Identifies the Bill of Material of item for which country of origin is captured.
• inventoryOrganization: inventoryOrganization
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• inventoryOrganizationGid: string
  The GID for the inventory organization/contact associated with the item origin.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• itemOriginGid: string
  The GID for the item origin.
• itemOriginXid: string
  The XID for the item origin.
• links: array links
  Read Only: true
• partner: partner
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• partnerGid: string
  The GID for the partner/party associated with the item origin.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• partnerSiteGid: string
  The GID for the party site associated with the item origin.
• percentageSourced: number (double)
  The percentage sourced from the supplier.
• qualifications: qualifications
• values: values
• whollyOriginating: string
  Indicates if the item is wholly originating.

{
    "properties":{
        "itemOriginGid":{
            "description":"The GID for the item origin.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "itemOriginXid":{
            "description":"The XID for the item origin.",
            "type":"string"
        },
        "inventoryOrganizationGid":{
            "description":"The GID for the inventory organization/contact associated with the item origin. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "inventoryOrganization":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "partnerGid":{
            "description":"The GID for the partner/party associated with the item origin. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "partner":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "partnerSiteGid":{
            "description":"The GID for the party site associated with the item origin.",
            "type":"string"
        },
        "countryOfOrigin":{
            "description":"The country of origin for the item origin.",
            "type":"string"
        },
        "countryOfManufacture":{
            "description":"The country of manufacture for the item origin.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for the item origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date for the item origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "description":{
            "description":"Identifies the description of item by partner/partner site, inventory organization, and bill of material.",
            "type":"string"
        },
        "gtmStructureGid":{
            "description":"Identifies the Bill of Material of item for which country of origin is captured.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "whollyOriginating":{
            "description":"Indicates if the item is wholly originating.",
            "type":"string"
        },
        "percentageSourced":{
            "description":"The percentage sourced from the supplier.",
            "type":"number",
            "format":"double"
        },
        "values":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.values"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "qualifications":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : effectiveDate

The effective date for the item origin.

Match All

The effective date for the item origin.

Show Source

• object dateType

{
    "description":"The effective date for the item origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date for the item origin.

Match All

The expiration date for the item origin.

Show Source

• object dateType

{
    "description":"The expiration date for the item origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : inventoryOrganization

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : partner

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : qualifications

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : values

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.values"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• classificationCode: string
  The product classification code associated with the product classification type of the item qualification.
• conditions: conditions
• countryOfImport: string
  This describes the country of import for the item
• description: string
  Describes the item qualification.
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for the item qualification.
• expirationDate: expirationDate
  The expiration date for the item qualification.
• gtmProdClassTypeGid: string
  The GID for the product classification type of the importing country.
• gtmReasonCodeGid: string
  Reason Code Id when status is evaluated to REQUIRES REVIEW
• gtmStructureGid: string
  Identifies the Bill of Material of item for which qualification is captured.
• gtmTariffCode: string
  Specifies the tariff code for a particular item qualification.
• gtmTradeAgreementGid: string
  The GID for the trade agreement associated with the item qualification.
• isQualified: string
  Indicates if an item qualified for a trade agreement. Can have "Y","N" and "NS" and default value is "NS"
• itemQfGid: string
  The GID for the item qualification.
• itemQfXid: string
  The XID for the item qualification.
• links: array links
  Read Only: true
• minOpsMeet: string
  This flag indicates if minimum operations are met under Rules of Origin.
• producer: string
  Indicates if the supplier/partner is the producer of the goods.
• qfPreferenceCriteriaGid: string
  The GID for the preference criteria associated with an item qualification.
• qfRvcMethodGid: string
  The GID for the regional value content method associated with an item qualification.
• refnums: refnums
• remarks: remarks
• reqdocs: reqdocs
• rooAttribute: string
  Indicates the attribute description under the product specific rule(suffix/ex) after the Rules of Origin Qualification
• rvcPercentage: number (double)
  The percentage of the regional value content method associated with an item qualification.
• status: string
  Indicates the status of an item qualification.
• values: values
• whollyOriginated: string
  Indicates if the Item is wholly originating under the trade agreement

{
    "properties":{
        "itemQfGid":{
            "description":"The GID for the item qualification.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "itemQfXid":{
            "description":"The XID for the item qualification.",
            "type":"string"
        },
        "description":{
            "description":"Describes the item qualification.",
            "type":"string"
        },
        "gtmTradeAgreementGid":{
            "description":"The GID for the trade agreement associated with the item qualification.",
            "type":"string"
        },
        "gtmProdClassTypeGid":{
            "description":"The GID for the product classification type of the importing country. ",
            "type":"string"
        },
        "classificationCode":{
            "description":"The product classification code associated with the product classification type of the item qualification.",
            "type":"string"
        },
        "isQualified":{
            "description":"Indicates if an item qualified for a trade agreement. Can have \"Y\",\"N\" and \"NS\" and default value is \"NS\"",
            "type":"string"
        },
        "qfPreferenceCriteriaGid":{
            "description":"The GID for the preference criteria associated with an item qualification. ",
            "type":"string"
        },
        "qfRvcMethodGid":{
            "description":"The GID for the regional value content method associated with an item qualification. ",
            "type":"string"
        },
        "producer":{
            "description":"Indicates if the supplier/partner is the producer of the goods.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for the item qualification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date for the item qualification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "status":{
            "description":"Indicates the status of an item qualification. ",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "gtmTariffCode":{
            "description":"Specifies the tariff code for a particular item qualification.",
            "type":"string"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "rvcPercentage":{
            "description":"The percentage of the regional value content method associated with an item qualification. ",
            "type":"number",
            "format":"double"
        },
        "minOpsMeet":{
            "description":"This flag indicates if minimum operations are met under Rules of Origin.",
            "type":"string"
        },
        "rooAttribute":{
            "description":"Indicates the attribute description under the product specific rule(suffix/ex) after the Rules of Origin Qualification",
            "type":"string"
        },
        "whollyOriginated":{
            "description":"Indicates if the Item is wholly originating under the trade agreement",
            "type":"string"
        },
        "countryOfImport":{
            "description":"This describes the country of import for the item",
            "type":"string"
        },
        "gtmReasonCodeGid":{
            "description":"Reason Code Id when status is evaluated to REQUIRES REVIEW",
            "type":"string"
        },
        "gtmStructureGid":{
            "description":"Identifies the Bill of Material of item for which qualification is captured.",
            "type":"string"
        },
        "values":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.values"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "conditions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : conditions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for the item qualification.

Match All

The effective date for the item qualification.

Show Source

• object dateType

{
    "description":"The effective date for the item qualification.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date for the item qualification.

Match All

The expiration date for the item qualification.

Show Source

• object dateType

{
    "description":"The expiration date for the item qualification.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : values

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.values"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : itemsWithProdClassCodeGid.itemOrigins.qualifications.conditions

Type: object

Show Source

• conditionDescription: string
  Description field.
• conditionShortName: string
  The short name given to rules of origin rule code.
• domainName: string
  No description.
• isApplied: boolean
  Indicates if the condition applied
• links: array links
  Read Only: true
• seqNumber: number (int64)
  Sequence number of the item qf condition.

{
    "properties":{
        "seqNumber":{
            "description":"Sequence number of the item qf condition.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "conditionShortName":{
            "description":"The short name given to rules of origin rule code.",
            "type":"string"
        },
        "conditionDescription":{
            "description":"Description field.",
            "type":"string"
        },
        "isApplied":{
            "description":"Indicates if the condition applied ",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemQfRefnumQualGid: string
  The GID for the item qualification reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The value of the reference number.

{
    "properties":{
        "itemQfRefnumQualGid":{
            "description":"The GID for the item qualification reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The value of the reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the item qualification remark.
• remarkSequence: number (int64)
  The sequence number for the item qualification remark.
• remarkText: string
  The remark text for the item qualification.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the item qualification remark. ",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"The GID for the item qualification remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text for the item qualification.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• docs: docs
• documentDefGid: string
  The GID for the required document type.
• domainName: string
  Database domain where this data is stored.
• instructions: string
  Free-form field to hold document attributes. E.g. a document could be denoted as required or optional.
• links: array links
  Read Only: true
• numRevisions: number (int32)
  The number of document revisions generated.
• reviewers: reviewers
• reviewStatus: string
  The review status of the required document.
• statuses: statuses

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the required document type.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numRevisions":{
            "description":"The number of document revisions generated.",
            "type":"number",
            "format":"int32"
        },
        "reviewStatus":{
            "description":"The review status of the required document. ",
            "type":"string"
        },
        "instructions":{
            "description":"Free-form field to hold document attributes. E.g. a document could be denoted as required or optional.",
            "type":"string"
        },
        "docs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.reviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : docs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : reviewers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.reviewers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• annotations: string
  Annotations for a document revision.
• document: document
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• documentCmsName: string
  The document name used to identify a set of revisions (versions) for a CMS.
• documentGid: string
  The GID for the document instance.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentRevision: number (int32)
  The revision count for the document.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• review: string
  The review status of the required document.
• reviewers: reviewers

{
    "properties":{
        "documentGid":{
            "description":"The GID for the document instance. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "document":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "documentRevision":{
            "description":"The revision count for the document.",
            "type":"number",
            "format":"int32"
        },
        "review":{
            "description":"The review status of the required document. ",
            "type":"string"
        },
        "annotations":{
            "description":"Annotations for a document revision.",
            "type":"string"
        },
        "documentCmsName":{
            "description":"The document name used to identify a set of revisions (versions) for a CMS.",
            "type":"string"
        },
        "reviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs.reviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : document

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : reviewers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs.reviewers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.docs.reviewers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comments: string
  Comments from the reviewer for the specific document.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the document reviewer.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• state: string
  The review status of the document.

{
    "properties":{
        "contactGid":{
            "description":"The GID for the document reviewer. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "state":{
            "description":"The review status of the document.",
            "type":"string"
        },
        "comments":{
            "description":"Comments from the reviewer for the specific document.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.reviewers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the document reviewer.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The GID for the document reviewer. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : itemsWithProdClassCodeGid.itemOrigins.qualifications.reqdocs.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type associated with a required document.
• statusValueGid: string
  The status value associated with a required document.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type associated with a required document.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value associated with a required document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.qualifications.values"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• currencyValue: currencyValue
  The currency value of the item qualification.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• gtmValueQualifierGid: string
  The GID for the value qualifier on the item qualification.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID for the value qualifier on the item qualification.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "currencyValue":{
            "description":"The currency value of the item qualification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : currencyValue

The currency value of the item qualification.

Match All

The currency value of the item qualification.

Show Source

• object currencyType

{
    "description":"The currency value of the item qualification.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemOrigins.values"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• currencyValue: currencyValue
  The currency value of the item origin.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• gtmValueQualifierGid: string
  The GID for the value qualifier on the item origin.
• links: array links
  Read Only: true

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID for the value qualifier on the item origin.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "currencyValue":{
            "description":"The currency value of the item origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : currencyValue

The currency value of the item origin.

Match All

The currency value of the item origin.

Show Source

• object currencyType

{
    "description":"The currency value of the item origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• countryOfOriginGid: string
  Identifies the origin of the goods corresponding on the item value set.
• domainName: string
  Database domain where this data is stored.
• identifier1: string
  Indicates the identifier corresponding on the item value set.
• identifier2: string
  Indicates the identifier corresponding on the item value set.
• identifier3: string
  Indicates the identifier corresponding on the item value set.
• inventoryOrganization: inventoryOrganization
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• inventoryOrganizationGid: string
  Identifies the inventory organization corresponding to the item value set.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• itemValues: itemValues
• links: array links
  Read Only: true
• lotNumber: string
  Identifies the lot number corresponding on the item value set.
• packageItem: packageItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packageItemGid: string
  Identifies the package item corresponding to the item value set.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• partner: partner
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• partnerGid: string
  Identifies the partner corresponding to the item value set.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• partnerSiteGid: string
  Identifies the partner site corresponding to the item value set.
• seqNumber: number (int32)
  Sequence number of the item value set
• serialNumber: string
  Identifies the sequence number corresponding on the item value set

{
    "properties":{
        "seqNumber":{
            "description":"Sequence number of the item value set",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "inventoryOrganizationGid":{
            "description":"Identifies the inventory organization corresponding to the item value set. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "inventoryOrganization":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "partnerGid":{
            "description":"Identifies the partner corresponding to the item value set. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "partner":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "partnerSiteGid":{
            "description":"Identifies the partner site corresponding to the item value set.",
            "type":"string"
        },
        "packageItemGid":{
            "description":"Identifies the package item corresponding to the item value set. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packageItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "countryOfOriginGid":{
            "description":"Identifies the origin of the goods corresponding on the item value set.",
            "type":"string"
        },
        "lotNumber":{
            "description":"Identifies the lot number corresponding on the item value set.",
            "type":"string"
        },
        "serialNumber":{
            "description":"Identifies the sequence number corresponding on the item value set",
            "type":"string"
        },
        "identifier1":{
            "description":"Indicates the identifier corresponding on the item value set.",
            "type":"string"
        },
        "identifier2":{
            "description":"Indicates the identifier corresponding on the item value set.",
            "type":"string"
        },
        "identifier3":{
            "description":"Indicates the identifier corresponding on the item value set.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "itemValues":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets.itemValues"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : inventoryOrganization

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property inventoryOrganizationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : itemValues

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets.itemValues"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packageItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packageItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : partner

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property partnerGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.itemValueSets.itemValues"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any exchange rate currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• gtmValueQualifierGid: string
  The GID of the value qualifier corresponding to the item value.
• links: array links
  Read Only: true
• value: value
  The currency value corresponding to the item value.

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID of the value qualifier corresponding to the item value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "value":{
            "description":"The currency value corresponding to the item value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any exchange rate currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any exchange rate currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any exchange rate currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any exchange rate currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : value

The currency value corresponding to the item value.

Match All

The currency value corresponding to the item value.

Show Source

• object currencyType

{
    "description":"The currency value corresponding to the item value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• bbHandlingType: string
  Indicates the Batch Balancer handling type for the packaged item. Valid handling types are conveyable, non-conveyable, and repack. Batch Balancer logic uses this info to determine potential batches for order release line assignment in the event an order release needs to be split across multiple batches.
• bulkMixingFamilyGid: string
  Indicates the bulk mixing family the packaged item belongs to.
• categoryGid: string
  The GID for the packaged item category.
• compartmentTypeProfGid: string
  Compartment type profile attached to the packaged item.
• coreDiameter: coreDiameter
  For cylindrical objects, this defines the diameter of the core.
• description: string
  Packaged item free form text field for the description. For example, a case of soda.
• domainName: string
  Database domain where this data is stored.
• equipmentRefUnits: equipmentRefUnits
• hazmatPackageTypeGid: string
  The GID for the hazmat package type. This field can be used to give the packaged item a special description. If you are defining a hazardous material, use this field to describe it.
• incrNestingHeight: incrNestingHeight
  Specifies the incremental nesting height for the PI
• innerPackCount: number (double)
  The count for the number of items in the inner pack.
• innerPackPackagingUnitGid: string
  The packaging unit related to the count for the number of items in the inner pack.
• innerPackSize: number (double)
  Indicates the inner pack count or size. The inner pack size unit of measure qualified the value entered here.
• innerPackSizeUomCode: string
  Unit of measure for the pack size entry. Packaged item = case of soda - inner pack = six pack inner pack size = 4, inner pack unit of measure = six pack.
• isAllowMixedFreight: boolean
  Allow mixed freight should be selected if the packaged item can be packed into a ship unit with other mixable packaged items.
• isDefaultPackaging: boolean
  Check box indicating if the information entered is the default packaging for this item.
• isHazardous: boolean
  Check box indicating if the information entered is the packaged item is considered hazardous.
• isNestable: boolean
  Specifies if the packaged item is nestable or not
• links: array links
  Read Only: true
• loadConfigRuleRank: number (int32)
  During 3D loading of mixed items, the packaged item with the highest rank will be used to find the matching stackability rule and load config rule.
• packagedItemGid: string
  The GID for the packaged item.
• packagedItemTypeGid: string
  Type of packaged item.
• packagedItemXid: string
  The XID for the packaged item.
• packageRefUnits: packageRefUnits
• packageShipUnitWeight: packageShipUnitWeight
  The weight of the ship unit.
• packageSuDiameter: packageSuDiameter
  Packaged ship unit diameter.
• packageSuHeight: packageSuHeight
  Package ship unit ship unit height.
• packageSuLength: packageSuLength
  Package ship unit ship unit length.
• packageSuVolume: packageSuVolume
  Packaged ship unit volume.
• packageSuWidth: packageSuWidth
  Packaged ship unit width.
• packagingUnitGid: string
  The GID for the packaging unit.
• parcelPacktype: string
  Parcel package type.
• priority: number (int32)
  This column defines the priority associated with an packaged item.
• pruUsages: pruUsages
• refnums: refnums
• thuProfileGid: string
  Defines all valid THUs the PI can be packed into.
• tiHis: tiHis

{
    "properties":{
        "packagedItemGid":{
            "description":"The GID for the packaged item.",
            "type":"string"
        },
        "packagedItemXid":{
            "description":"The XID for the packaged item.",
            "type":"string"
        },
        "description":{
            "description":"Packaged item free form text field for the description. For example, a case of soda.",
            "type":"string"
        },
        "hazmatPackageTypeGid":{
            "description":"The GID for the hazmat package type. This field can be used to give the packaged item a special description. If you are defining a hazardous material, use this field to describe it.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit. ",
            "type":"string"
        },
        "packageShipUnitWeight":{
            "description":"The weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "innerPackCount":{
            "description":"The count for the number of items in the inner pack.",
            "type":"number",
            "format":"double"
        },
        "innerPackPackagingUnitGid":{
            "description":"The packaging unit related to the count for the number of items in the inner pack.",
            "type":"string"
        },
        "innerPackSize":{
            "description":"Indicates the inner pack count or size. The inner pack size unit of measure qualified the value entered here.",
            "type":"number",
            "format":"double"
        },
        "innerPackSizeUomCode":{
            "description":"Unit of measure for the pack size entry. Packaged item = case of soda - inner pack = six pack inner pack size = 4, inner pack unit of measure = six pack.",
            "type":"string"
        },
        "packageSuVolume":{
            "description":"Packaged ship unit volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuLength":{
            "description":"Package ship unit ship unit length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuWidth":{
            "description":"Packaged ship unit width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuHeight":{
            "description":"Package ship unit ship unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isDefaultPackaging":{
            "description":"Check box indicating if the information entered is the default packaging for this item. ",
            "type":"boolean"
        },
        "isHazardous":{
            "description":"Check box indicating if the information entered is the packaged item is considered hazardous.",
            "type":"boolean"
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageSuDiameter":{
            "description":"Packaged ship unit diameter.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bbHandlingType":{
            "description":"Indicates the Batch Balancer handling type for the packaged item. Valid handling types are conveyable, non-conveyable, and repack. Batch Balancer logic uses this info to determine potential batches for order release line assignment in the event an order release needs to be split across multiple batches.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagedItemTypeGid":{
            "description":"Type of packaged item.",
            "type":"string"
        },
        "loadConfigRuleRank":{
            "description":"During 3D loading of mixed items, the packaged item with the highest rank will be used to find the matching stackability rule and load config rule.",
            "type":"number",
            "format":"int32"
        },
        "thuProfileGid":{
            "description":"Defines all valid THUs the PI can be packed into.",
            "type":"string"
        },
        "parcelPacktype":{
            "description":"Parcel package type.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isAllowMixedFreight":{
            "description":"Allow mixed freight should be selected if the packaged item can be packed into a ship unit with other mixable packaged items.",
            "type":"boolean"
        },
        "bulkMixingFamilyGid":{
            "description":"Indicates the bulk mixing family the packaged item belongs to.",
            "type":"string"
        },
        "compartmentTypeProfGid":{
            "description":"Compartment type profile attached to the packaged item.",
            "type":"string"
        },
        "categoryGid":{
            "description":"The GID for the packaged item category.",
            "type":"string"
        },
        "priority":{
            "description":"This column defines the priority associated with an packaged item.",
            "type":"number",
            "format":"int32"
        },
        "isNestable":{
            "description":"Specifies if the packaged item is nestable or not",
            "type":"boolean"
        },
        "incrNestingHeight":{
            "description":"Specifies the incremental nesting height for the PI",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "pruUsages":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.pruUsages"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "tiHis":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.tiHis"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packageRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.packageRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : coreDiameter

For cylindrical objects, this defines the diameter of the core.

Match All

For cylindrical objects, this defines the diameter of the core.

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the core.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : incrNestingHeight

Specifies the incremental nesting height for the PI

Match All

Specifies the incremental nesting height for the PI

Show Source

• object amountType

{
    "description":"Specifies the incremental nesting height for the PI",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packageRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.packageRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : packageShipUnitWeight

The weight of the ship unit.

Match All

The weight of the ship unit.

Show Source

• object amountType

{
    "description":"The weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuDiameter

Packaged ship unit diameter.

Match All

Packaged ship unit diameter.

Show Source

• object amountType

{
    "description":"Packaged ship unit diameter.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuHeight

Package ship unit ship unit height.

Match All

Package ship unit ship unit height.

Show Source

• object amountType

{
    "description":"Package ship unit ship unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuLength

Package ship unit ship unit length.

Match All

Package ship unit ship unit length.

Show Source

• object amountType

{
    "description":"Package ship unit ship unit length.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuVolume

Packaged ship unit volume.

Match All

Packaged ship unit volume.

Show Source

• object amountType

{
    "description":"Packaged ship unit volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageSuWidth

Packaged ship unit width.

Match All

Packaged ship unit width.

Show Source

• object amountType

{
    "description":"Packaged ship unit width.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pruUsages

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.pruUsages"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tiHis

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.tiHis"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.equipmentRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  ERU for the packaged item
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of reference units per package for ERU.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"ERU for the packaged item",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The number of reference units per package for ERU.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.packageRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• innerPackCount: number (double)
  Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.
• links: array links
  Read Only: true
• packagingUnitGid: string
  The GID for the packaged unit.

{
    "properties":{
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "innerPackCount":{
            "description":"Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.pruUsages"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The GID for the packaging reference unit.
• packagingUnitGid: string
  The GID for the packaged unit.
• pruCount: number (double)
  The count for the number of packing reference units.
• sequenceNo: number (int64)
  Internal sequence number for packaged item, packing unit, packing reference unit, and packaging reference unit count entries.

{
    "properties":{
        "sequenceNo":{
            "description":"Internal sequence number for packaged item, packing unit, packing reference unit, and packaging reference unit count entries.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "packagingReferenceUnitGid":{
            "description":"The GID for the packaging reference unit.",
            "type":"string"
        },
        "pruCount":{
            "description":"The count for the number of packing reference units.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItemRefnumQualGid: string
  The GID for the packaged item reference number qualifier.
• refnumValue: string
  Value of reference number being added for this packaged item reference number qualifier.

{
    "properties":{
        "packagedItemRefnumQualGid":{
            "description":"The GID for the packaged item reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"Value of reference number being added for this packaged item reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.packagedItems.tiHis"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• numLayers: number (int32)
  Number of layers high. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the number of layers value is 4.
• packagingUnitGid: string
  The GID for the package unit.
• quantityPerLayer: number (int32)
  Number of items per layer. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the quantity per layer is 6.
• sequenceNo: number (int64)
  The internal sequence number for each entry entered for package item, packing unit, transport handling unit, layers, and quantity per layer.
• transportHandlingUnitGid: string
  The GID for the transport unit for the TiHi information being defined.

{
    "properties":{
        "sequenceNo":{
            "description":"The internal sequence number for each entry entered for package item, packing unit, transport handling unit, layers, and quantity per layer.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the package unit.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport unit for the TiHi information being defined.",
            "type":"string"
        },
        "numLayers":{
            "description":"Number of layers high. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the number of layers value is 4.",
            "type":"number",
            "format":"int32"
        },
        "quantityPerLayer":{
            "description":"Number of items per layer.  For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the quantity per layer is 6.",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerItems"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• partnerItemGid: string
  The GID for the partner item.

{
    "properties":{
        "partnerItemGid":{
            "description":"The GID for the partner item.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.partnerSites"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• partnerSiteGid: string
  The GID for the party site.

{
    "properties":{
        "partnerSiteGid":{
            "description":"The GID for the party site.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemRefnumQualGid: string
  The GID for the qualifier used to qualify the reference number being added. For example, part number.
• itemRefnumValue: string
  The value entered qualified by the reference number qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "itemRefnumQualGid":{
            "description":"The GID for the qualifier used to qualify the reference number being added.  For example, part number.",
            "type":"string"
        },
        "itemRefnumValue":{
            "description":"The value entered qualified by the reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.relationships"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• item: item
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itemGid: string
  The GID for the item that is having the previous item information added, updated, or removed.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true

{
    "properties":{
        "itemGid":{
            "description":"The GID for the item that is having the previous item information added, updated, or removed. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "item":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : item

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier.
• remarkSequence: number (int64)
  The sequence number for the item remark.
• remarkText: string
  The text of the remark about the item.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number for the item remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark about the item.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocReviews"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comments: string
  Changes.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the document contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• document: document
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• documentDefGid: string
  The GID for the document definition.
• documentGid: string
  The GID for the document instance.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• state: string
  Review info.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "documentGid":{
            "description":"The GID for the document instance. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "document":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "contactGid":{
            "description":"The GID for the document contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "state":{
            "description":"Review info.",
            "type":"string"
        },
        "comments":{
            "description":"Changes.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : document

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocDocs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• annotations: string
  Changes.
• document: document
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• documentCmsName: string
  The document name used to identify a set of revisions (versions) for a CMS.
• documentDefGid: string
  The GID for the document definition.
• documentGid: string
  The GID for the document instance.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentRevision: number (double)
  Count for the number of document revisions.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• review: string
  Review info.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "documentGid":{
            "description":"The GID for the document instance. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "document":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "documentRevision":{
            "description":"Count for the number of document revisions.",
            "type":"number",
            "format":"double"
        },
        "review":{
            "description":"Review info.",
            "type":"string"
        },
        "annotations":{
            "description":"Changes.",
            "type":"string"
        },
        "documentCmsName":{
            "description":"The document name used to identify a set of revisions (versions) for a CMS.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : document

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocReviewers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• asInvolvedPartyQualGid: string
  The GID for the involved party qualifier.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The GID for the document contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentDefGid: string
  The GID for the document definition.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "contactGid":{
            "description":"The GID for the document contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"The GID for the involved party qualifier.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  The GID for the document definition.
• domainName: string
  Database domain where this data is stored.
• instructions: string
  Document instructions.
• links: array links
  Read Only: true
• numRevisions: number (double)
  Count for the number of document revisions.
• reviewStatus: string
  Current review status for the document.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numRevisions":{
            "description":"Count for the number of document revisions.",
            "type":"number",
            "format":"double"
        },
        "reviewStatus":{
            "description":"Current review status for the document.",
            "type":"string"
        },
        "instructions":{
            "description":"Document instructions.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object itemsWithProdClassCodeGid.reqdocStatuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocStatuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : itemsWithProdClassCodeGid.reqdocStatuses

Type: object

Show Source

• documentDefGid: string
  The GID for the document definition.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The GID for the document status type.
• statusValueGid: string
  The GID for the document status value.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition.",
            "type":"string"
        },
        "statusTypeGid":{
            "description":"The GID for the document status type.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The GID for the document status value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocSubscribers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• asInvolvedPartyQualGid: string
  GID for the involved party qualifier for the subscriber.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  GID for the document definition contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentDefGid: string
  The GID for the document definition that the subscribers are being managed for.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition that the subscribers are being managed for.",
            "type":"string"
        },
        "contactGid":{
            "description":"GID for the document definition contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"GID for the involved party qualifier for the subscriber.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.reqdocTexts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  The GID for the document definition that the text template is being added, updated, or removed.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textTemplateGid: string
  The GID for the text template that is being added, updated, or removed.

{
    "properties":{
        "documentDefGid":{
            "description":"The GID for the document definition that the text template is being added, updated, or removed.",
            "type":"string"
        },
        "textTemplateGid":{
            "description":"The GID for the text template that is being added, updated, or removed.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The GID for the special service required for the item being shipped.

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special service required for the item being shipped.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The GID for the status type for the item.
• statusValueGid: string
  The GID for the status value for the item.

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the status type for the item.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The GID for the status value for the item.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  Document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for the text template.

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemsWithProdClassCodeGid.uomConversions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• conversionRate: number (double)
  The conversion rate between the from and to unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the conversion rate would be - for the standard LB to KG conversion - 0.453592.
• domainName: string
  Database domain where this data is stored.
• fromUomCode: string
  The from unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the from unit of measure would be pounds.
• guicSeqNum: number (int64)
  Internal sequence number for the item unit of measure conversion records.
• links: array links
  Read Only: true
• toUomCode: string
  The to unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the to unit of measure would be kilograms.

{
    "properties":{
        "guicSeqNum":{
            "description":"Internal sequence number for the item unit of measure conversion records.",
            "type":"number",
            "format":"int64"
        },
        "fromUomCode":{
            "description":"The from unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the from unit of measure would be pounds.",
            "type":"string"
        },
        "toUomCode":{
            "description":"The to unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the to unit of measure would be kilograms.",
            "type":"string"
        },
        "conversionRate":{
            "description":"The conversion rate between the from and to unit of measure for this entry. For example if you wish to convert from pounds (LB) to kilograms (KG) the conversion rate would be - for the standard LB to KG conversion - 0.453592.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.packageRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.packageRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItems.packageRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• innerPackCount: number (double)
  Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.
• links: array links
  Read Only: true
• packagingUnitGid: string
  The GID for the packaged unit.

{
    "properties":{
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "innerPackCount":{
            "description":"Count for the number of items in the inner pack. For example, case of soda inner pack six pack with count of four. The Inner Pack Count field gives you a place to enter how many of the item is packaged in this packaging unit. This information is for informational purposes only and will only be visible if you select Packaging Unit in the header section.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.pruUsages

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.pruUsages"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItems.pruUsages

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The GID for the packaging reference unit.
• packagingUnitGid: string
  The GID for the packaged unit.
• pruCount: number (double)
  The count for the number of packing reference units.
• sequenceNo: number (int64)
  Internal sequence number for packaged item, packing unit, packing reference unit, and packaging reference unit count entries.

{
    "properties":{
        "sequenceNo":{
            "description":"Internal sequence number for packaged item, packing unit, packing reference unit, and packaging reference unit count entries.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaged unit.",
            "type":"string"
        },
        "packagingReferenceUnitGid":{
            "description":"The GID for the packaging reference unit.",
            "type":"string"
        },
        "pruCount":{
            "description":"The count for the number of packing reference units.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItems.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItemRefnumQualGid: string
  The GID for the packaged item reference number qualifier.
• refnumValue: string
  Value of reference number being added for this packaged item reference number qualifier.

{
    "properties":{
        "packagedItemRefnumQualGid":{
            "description":"The GID for the packaged item reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"Value of reference number being added for this packaged item reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object packagedItems.tiHis

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/packagedItems.tiHis"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItems.tiHis

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• numLayers: number (int32)
  Number of layers high. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the number of layers value is 4.
• packagingUnitGid: string
  The GID for the package unit.
• quantityPerLayer: number (int32)
  Number of items per layer. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the quantity per layer is 6.
• sequenceNo: number (int64)
  The internal sequence number for each entry entered for package item, packing unit, transport handling unit, layers, and quantity per layer.
• transportHandlingUnitGid: string
  The GID for the transport unit for the TiHi information being defined.

{
    "properties":{
        "sequenceNo":{
            "description":"The internal sequence number for each entry entered for package item, packing unit, transport handling unit, layers, and quantity per layer.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The GID for the package unit.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport unit for the TiHi information being defined.",
            "type":"string"
        },
        "numLayers":{
            "description":"Number of layers high. For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the number of layers value is 4.",
            "type":"number",
            "format":"int32"
        },
        "quantityPerLayer":{
            "description":"Number of items per layer.  For example, if a transport handling unit of a pallet can hold 24 cases - 4 layers with a quantity of 6 per layer the quantity per layer is 6.",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.equipmentRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• compartmentNum: number (int32)
  The equipment compartment number for which the ERU capacity is being defined.
• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The GID for the equipment group reference unit being defined.
• limitNumReferenceUnits: number (double)
  Limit for the number of ERUs. The limit allows you to set an artificial limit to allow the placement of up to a certain number of ERUs and then allows the equipment to be filled with other ERUs.
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The maximum number of ERUs that can be held in the compartment.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"The GID for the equipment group reference unit being defined.",
            "type":"string"
        },
        "compartmentNum":{
            "description":"The equipment compartment number for which the ERU capacity is being defined. ",
            "type":"number",
            "format":"int32"
        },
        "numReferenceUnits":{
            "description":"The maximum number of ERUs that can be held in the compartment.",
            "type":"number",
            "format":"double"
        },
        "limitNumReferenceUnits":{
            "description":"Limit for the number of ERUs. The limit allows you to set an artificial limit to allow the placement of up to a certain number of ERUs and then allows the equipment to be filled with other ERUs.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.equipmentTypes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentType: equipmentType
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentTypeGid: string
  The GID for the equipment type.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentTypeGid":{
            "description":"The GID for the equipment type. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentType":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentTypes"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentType

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object equipmentTypes

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentTypes"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : equipmentTypes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentDesc: string
  A textual description of the equipment type.
• equipmentDescCode: string
  The equipment description code is a user-defined code for the equipment type description.
• equipmentDescCodeDef: string
  The equipment description code definition is a definition of the equipment type description code.
• equipmentGroups: equipmentGroups
• equipmentTypeGid: string
  The GID for the equipment type. Equipment Types are used to define the characteristics of an equipment group. Using Intermodal Trailers as an example of an equipment group profile, the group in that profile could be 45' or 48' trailers. The equipment type against that group would be either a rollup or swing door trailer.
• equipmentTypeName: string
  Text for the name of the equipment type.
• equipmentTypeXid: string
  The XID for the equipment type.
• exteriorHeight: exteriorHeight
  The height of the exterior of the equipment type.
• exteriorLength: exteriorLength
  The length of the exterior of the equipment type.
• exteriorWidth: exteriorWidth
  The width of the exterior of the equipment type.
• grossWeight: grossWeight
  The equipment type's gross weight.
• insertDate: insertDate
  Read Only: true

  insert date
• interiorHeight: interiorHeight
  The height of the equipment type's interior.
• interiorLength: interiorLength
  The length of the equipment type's interior.
• interiorWidth: interiorWidth
  The width of the equipment type's interior.
• isoEquipmentCode: string
  This is the official International Standards Organization (ISO) code for the container that may be used with this equipment type (EDI element 24). This code identifies the size and type of container in a four-character format. The first and second characters specify the volume of the container, and the third and fourth characters specify the type. This code may or may not be the same as the equipment description code.
• isoEquipmentCodeDef: string
  The ISO equipment code definition is an explanation of the ISO equipment code.
• links: array links
  Read Only: true
• metric3: number (double)
  The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.
• metric4: number (double)
  The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.
• netWeight: netWeight
  The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.
• remarks: remarks
• specialServices: specialServices
• substituteEqTypeProfileGid: string
  Indicates which equipment types can be substituted for this type in fleet equipment planning.
• tag1: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag2: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag3: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag4: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tareWeight: tareWeight
  Weight of the empty equipment type.
• temperatureControl: boolean
  Check box used to enable temperature control functionality to be used for this equipment type.
• temperatureControlGid: string
  A GID to define the temperature controls value for the commodity.
• updateDate: updateDate
  Read Only: true

  update date
• volume: volume
  The volume of the equipment type.

{
    "properties":{
        "equipmentTypeGid":{
            "description":"The GID for the equipment type. Equipment Types are used to define the characteristics of an equipment group. Using Intermodal Trailers as an example of an equipment group profile, the group in that profile could be 45' or 48' trailers. The equipment type against that group would be either a rollup or swing door trailer.",
            "type":"string"
        },
        "equipmentTypeXid":{
            "description":"The XID for the equipment type.",
            "type":"string"
        },
        "equipmentTypeName":{
            "description":"Text for the name of the equipment type.",
            "type":"string"
        },
        "equipmentDesc":{
            "description":"A textual description of the equipment type.",
            "type":"string"
        },
        "equipmentDescCode":{
            "description":"The equipment description code is a user-defined code for the equipment type description.",
            "type":"string"
        },
        "equipmentDescCodeDef":{
            "description":"The equipment description code definition is a definition of the equipment type description code.",
            "type":"string"
        },
        "isoEquipmentCode":{
            "description":"This is the official International Standards Organization (ISO) code for the container that may be used with this equipment type (EDI element 24). This code identifies the size and type of container in a four-character format. The first and second characters specify the volume of the container, and the third and fourth characters specify the type. This code may or may not be the same as the equipment description code.",
            "type":"string"
        },
        "isoEquipmentCodeDef":{
            "description":"The ISO equipment code definition is an explanation of the ISO equipment code.",
            "type":"string"
        },
        "grossWeight":{
            "description":"The equipment type's gross weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"Weight of the empty equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "netWeight":{
            "description":"The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "metric3":{
            "description":"The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.",
            "type":"number",
            "format":"double"
        },
        "metric4":{
            "description":"The Metric field represents an additional level of detail for a shipment on a given equipment type. For example, you can enter information about items being transported without packaging, such as a number of garments not packed into crates or onto pallets but instead placed on hangers. This number must be no greater than eight digits.",
            "type":"number",
            "format":"double"
        },
        "interiorLength":{
            "description":"The length of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "interiorWidth":{
            "description":"The width of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "interiorHeight":{
            "description":"The height of the equipment type's interior.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorLength":{
            "description":"The length of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorWidth":{
            "description":"The width of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "exteriorHeight":{
            "description":"The height of the exterior of the equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "temperatureControl":{
            "description":"Check box used to enable temperature control functionality to be used for this equipment type.",
            "type":"boolean"
        },
        "temperatureControlGid":{
            "description":"A GID to define the temperature controls value for the commodity.",
            "type":"string"
        },
        "tag1":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag2":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag3":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag4":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "substituteEqTypeProfileGid":{
            "description":"Indicates which equipment types can be substituted for this type in fleet equipment planning.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "equipmentGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.equipmentGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipmentTypes.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentTypes.equipmentGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exteriorHeight

The height of the exterior of the equipment type.

Match All

The height of the exterior of the equipment type.

Show Source

• object amountType

{
    "description":"The height of the exterior of the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : exteriorLength

The length of the exterior of the equipment type.

Match All

The length of the exterior of the equipment type.

Show Source

• object amountType

{
    "description":"The length of the exterior of the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : exteriorWidth

The width of the exterior of the equipment type.

Match All

The width of the exterior of the equipment type.

Show Source

• object amountType

{
    "description":"The width of the exterior of the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : grossWeight

The equipment type's gross weight.

Match All

The equipment type's gross weight.

Show Source

• object amountType

{
    "description":"The equipment type's gross weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : interiorHeight

The height of the equipment type's interior.

Match All

The height of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The height of the equipment type's interior.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : interiorLength

The length of the equipment type's interior.

Match All

The length of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The length of the equipment type's interior.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : interiorWidth

The width of the equipment type's interior.

Match All

The width of the equipment type's interior.

Show Source

• object amountType

{
    "description":"The width of the equipment type's interior.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : netWeight

The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.

Match All

The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.

Show Source

• object amountType

{
    "description":"The net or nominal weight is the anticipated weight capacity of the shipment that can be contained within the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentTypes.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipmentTypes.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tareWeight

Weight of the empty equipment type.

Match All

Weight of the empty equipment type.

Show Source

• object amountType

{
    "description":"Weight of the empty equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : volume

The volume of the equipment type.

Match All

The volume of the equipment type.

Show Source

• object amountType

{
    "description":"The volume of the equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentTypes.equipmentGroups

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentTypes.equipmentGroups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : equipmentTypes.equipmentGroups

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  The GID for the equipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentTypes.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentTypes.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : equipmentTypes.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier being entered for the equipment type.
• remarkSequence: number (int64)
  Sequence number for entered remarks.
• remarkText: string
  The remark text being entered for the selected remark qualifier.

{
    "properties":{
        "remarkSequence":{
            "description":"Sequence number for entered remarks.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier being entered for the equipment type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text being entered for the selected remark qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipmentTypes.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentTypes.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : equipmentTypes.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this special service for this equipment type.
• expirationDate: expirationDate
  The expiration date of this special service for this equipment type.
• links: array links
  Read Only: true
• specialServiceGid: string
  The GID for the special service being entered for the equipment type.

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special service being entered for the equipment type.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date of this special service for this equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this special service for this equipment type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this special service for this equipment type.

Match All

The effective date of this special service for this equipment type.

Show Source

• object dateType

{
    "description":"The effective date of this special service for this equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date of this special service for this equipment type.

Match All

The expiration date of this special service for this equipment type.

Show Source

• object dateType

{
    "description":"The expiration date of this special service for this equipment type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.obstructions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• compartmentNum: number (int32)
  The equipment compartment number for which the obstruction is being defined.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• obstrHeight: obstrHeight
  The height coordinate for the obstruction.
• obstrLength: obstrLength
  The length of the obstruction.
• obstructionName: string
  Name given to obstruction.
• obstructionNum: number (int32)
  Number identifier for the obstruction.
• obstrWidth: obstrWidth
  The width of the obstruction.
• startHeightPosition: startHeightPosition
  The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
• startLengthPosition: startLengthPosition
  The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.
• startWidthPosition: startWidthPosition
  The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

{
    "properties":{
        "compartmentNum":{
            "description":"The equipment compartment number for which the obstruction is being defined.",
            "type":"number",
            "format":"int32"
        },
        "obstructionNum":{
            "description":"Number identifier for the obstruction.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "obstructionName":{
            "description":"Name given to obstruction.",
            "type":"string"
        },
        "startLengthPosition":{
            "description":"The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startWidthPosition":{
            "description":"The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "startHeightPosition":{
            "description":"The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "obstrLength":{
            "description":"The length of the obstruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "obstrWidth":{
            "description":"The width of the obstruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "obstrHeight":{
            "description":"The height coordinate for the obstruction. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : obstrHeight

The height coordinate for the obstruction.

Match All

The height coordinate for the obstruction.

Show Source

• object amountType

{
    "description":"The height coordinate for the obstruction. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : obstrLength

The length of the obstruction.

Match All

The length of the obstruction.

Show Source

• object amountType

{
    "description":"The length of the obstruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : obstrWidth

The width of the obstruction.

Match All

The width of the obstruction.

Show Source

• object amountType

{
    "description":"The width of the obstruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startHeightPosition

The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Match All

The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Show Source

• object amountType

{
    "description":"The start height position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startLengthPosition

The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Match All

The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Show Source

• object amountType

{
    "description":"The start length position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : startWidthPosition

The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Match All

The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.

Show Source

• object amountType

{
    "description":"The start width position coordinate for the obstruction. The starting coordinate is from the forward left corner of the truck.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.packagedItems"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item that is linked to the equipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "packagedItemGid":{
            "description":"The packaged item that is linked to the equipment group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.shipUnitSpecCompatibilities"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• transportHandlingUnitGid: string
  The GID for the transport handling unit.

{
    "properties":{
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipmentGroups.vehicleTypeCompatibilities"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• vehicleTypeGid: string
  The GID for the vehicle type. Vehicle type generally refers to the type of equipment (aircraft) that will be linked to an air schedule. Vehicle types contain door height and width dimensions that must be added to the equipment group so that ship units assigned to that equipment group can fit through the door when they are loaded onto the plane. For example, you can create a ship unit with dimensions of 10 feet in height by 10 feet in width. You can then assign that ship unit to an equipment group. If you create a vehicle type and assign it to that equipment group, then the vehicle type's door dimensions must be larger than those of the ship unit (for example, 20 feet in height and 20 feet in width).
  If these door dimensions are not larger than the ship unit dimensions and the equipment group is assigned to a shipment, shipment planning produces an infeasible shipment with this equipment group.
  If you setup your vehicle types without any equipment groups, the system will check the ship unit against door dimensions on the vehicle type "loose freight" scenario.
  If you make an association between the vehicle type and an equipment group, then the system no longer does the door dimension check, but does a check to see if the equipment group assigned to the shipment is compatible with the equipment group(s) associated with the vehicle type.

{
    "properties":{
        "vehicleTypeGid":{
            "description":"The GID for the vehicle type. Vehicle type generally refers to the type of equipment (aircraft) that will be linked to an air schedule. Vehicle types contain door height and width dimensions that must be added to the equipment group so that ship units assigned to that equipment group can fit through the door when they are loaded onto the plane. For example, you can create a ship unit with dimensions of 10 feet in height by 10 feet in width. You can then assign that ship unit to an equipment group. If you create a vehicle type and assign it to that equipment group, then the vehicle type's door dimensions must be larger than those of the ship unit (for example, 20 feet in height and 20 feet in width).<br>If these door dimensions are not larger than the ship unit dimensions and the equipment group is assigned to a shipment, shipment planning produces an infeasible shipment with this equipment group.<br>If you setup your vehicle types without any equipment groups, the system will check the ship unit against door dimensions on the vehicle type \"loose freight\" scenario.<br>If you make an association between the vehicle type and an equipment group, then the system no longer does the door dimension check, but does a check to see if the equipment group assigned to the shipment is compatible with the equipment group(s) associated with the vehicle type.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• calendarGid: string
  Contains the GID for the calendar.
• corporationProfileGid: string
  Contains the GID for the corporation profile used for the itinerary.
• deliveryStopsConstraints: number (int32)
  The total number of pickup stops for a multistop shipment. It is usually set to be the maximum of the Delivery Stops Constraints of all valid rate offering. This help multistop performance.
• depotProfileGid: string
  The GID for the depot profile. The depot profile defines the lane and Source and/or Destination Depot Location that are considered during planning for service providers that start and end at depot locations.
• description: string
  Contains text describing the itinerary.
• domainName: string
  Database domain where this data is stored.
• hazmatModeGid: string
  The GID for the hazardous transport mode. It can be used to differentiate between goods from different orders that can be consolidated into one shipment for one or more legs of the trip.
• incoTermProfileGid: string
  The GID for the INCO Term profile. The Incoterm Profile can be used to constrain the itinerary as a valid choice for shipment planning for any order that has the same Incoterm attributes as the profile. Note: If you use this field, you can also specify a Payment Method code on each leg of the itinerary which is then copied to the shipment that is built for that leg (overriding any Payment Method code defined on the order base).
• insertDate: insertDate
  Read Only: true

  insert date
• isDestBundlePrefered: boolean
  If this is selected, when going through the deconsolidation pool process, if there is a cross dock on this itinerary, two or more order bundles have the same destination will not route to the deconsolidation pool. It will route to cross dock later for consolidation at the cross dock and directly go to the destination.
• isMatchConsolPoolToSrc: boolean
  The Match Deconsol Pool to Src check box sets the pool logic so that it matches orders to deconsolidation pools based on order's source location. If it is selected pool logic matches orders to consolidation pools based on order's source locations. If the check box is cleared, Oracle Transportation Management matches orders to consolidation pools according to the order's destination locations.
• isMatchDeconsolPoolToDest: boolean
  The Match Deconsol Pool to Dest check box sets the pool logic so that it matches orders to deconsolidation pools based on order's destination locations. If this is not selected, Oracle Transportation Management matches orders to deconsolidation pools according to the order's source location.
• isMultiStop: boolean
  Describes whether the itinerary contains more than one stop. If so, this column contains a Y for yes; if not it contains an N for no.
• isRule11: boolean
  N/A
• itineraryGid: string
  Contains the GID for the itinerary.
• itineraryName: string
  Contains the name for the itinerary.
• itineraryType: string
  By default, the Itinerary Type field displays Active which means that the itinerary can be used in shipment planning. Choose Inactive if you do not want this itinerary to be considered when building shipments. You can also choose Manual which means the itinerary should not be considered when running the Create Shipment - Bulk Plan, Direct, or Calculate Best Direct Cost actions. However, the itinerary is considered when running the Direct - Show Routing Options action.
• itineraryXid: string
  Contains the XID for the itinerary.
• legs: legs
• links: array links
  Read Only: true
• maxDistBtwDelvs: maxDistBtwDelvs
  The maximum distance between deliveries is used to limit the distance between delivery stops. If the distance between two delivery stops exceed this value, orders are not paired.
• maxDistBtwPickups: maxDistBtwPickups
  In some cases, it is more expensive to ship to a cross-dock than to ship direct because of the distance from the source to the cross-dock. To limit the distance you want shipments to travel to a cross-dock, enter a numeric value in the Maximum Distance between Pickups/Deliveries fields. If the distance between two pickup or delivery stops exceed this value, orders are not paired.
• maxPoolVolume: maxPoolVolume
  The maximum volume to go through a pool.
• maxPoolWeight: maxPoolWeight
  The Maximum Pool Weight field identifies the highest weight for shipments that use the pool. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a pool. If one field is populated, the order needs to be less than this value in order to be routed to a pool. If both are NULL, all orders qualify to be routed to a pool.
• maxSmallDirectVolume: maxSmallDirectVolume
  After pool swapping, the system attempts to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This volume guides the algorithm to only pull of the one that is smaller than this volume.
• maxSmallDirectWeight: maxSmallDirectWeight
  After pool swapping, the system tries to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This weight guides the algorithm to only pull of the one that is smaller than this weight.
• maxVolume: maxVolume
  Contains the maximum volume for the shipment on the itinerary.
• maxWeight: maxWeight
  Contains the maximum weight for the shipment on the itinerary.
• maxXdockVolume: maxXdockVolume
  The Max Cross Dock Volume field identifies the highest volume for shipments that use the cross dock.
• maxXdockWeight: maxXdockWeight
  The Max Cross Dock Weight field identifies the highest weight for shipments that use the cross dock. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a cross dock. If one field is populated, the order needs to be less than this value in order to be routed to a cross dock. If both are NULL, all orders qualify to be routed to a cross dock.
• minStopoffVolume: minStopoffVolume
  Order bundles less than this volume will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools. When doing pool drop swapping, only pool drop shipments whose volume is bigger than this value are tried.
• minStopoffWeight: minStopoffWeight
  Order bundles less than this weight will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools.
• minTlUsagePercentage: number (double)
  The percentage of usage to be used to determine whether a TL is full in bulk plan. This will guide whether direct shipment be kept without routing to pool. It also determines whether pool shipments be kept without routing to xdock.
• minTlVolume: minTlVolume
  This is the minimum volume to make up a nice truckload. It is also used as the minimum volume to go through a pool
• minTlWeight: minTlWeight
  This is the minimum weight to make up a nice truckload. It is also used as the minimum weight to go through a pool.
• minVolume: minVolume
  Contains the minimum volume for the shipment on the itinerary.
• minWeight: minWeight
  Contains the minimum weight for the shipment on the itinerary.
• paymentMethodProfileGid: string
  The list of compatible payment methods for the itinerary.
• perspective: string
  The perspective determines whether the itinerary is used for buy or sell shipment services. Perspective options include All (used for Buy and Sell), Buy, Sell.
• pickupStopsConstraints: number (int32)
  The total number of pickup stops for a multistop shipment. It is usually set to be the max of Pickup Stops Constraints of all valid rate offering. This helps multistop performance.
• radiusForDelvs: radiusForDelvs
  The maximum radial - straight line distance - from the source to each delivery stop location that can not be exceeded.
• radiusForPickups: radiusForPickups
  The distance from any pickup stop to the root bundle's source location can not exceed this distance.
• radiusPercentageForDelvs: number (double)
  The maximum radial percentage distance from the source to each delivery stop location that can not be exceeded.
• radiusPercentageForPickups: number (double)
  The distance from any pickup stop to the source location divided by the distance cannot exceed this percentage.
• rank: number (int32)
  N/A
• totalCost: totalCost
  N/A
• totalStopsConstraint: number (int32)
  Specifies the maximum number of stops on a multi-stop shipment derived from this itinerary.
• totalTransitTime: totalTransitTime
  N/A
• updateDate: updateDate
  Read Only: true

  update date
• useConsolidationPool: boolean
  Orders matched to this itinerary may use a consolidation pool on the source.
• useDeconsolidationPool: boolean
  Orders matched to this itinerary may use a deconsolidation pool on the destination.
• xLaneGid: string
  Contains the GID for the entity. It is created by concatenating the Domain Name,"." and the XID.

{
    "properties":{
        "itineraryGid":{
            "description":"Contains the GID for the itinerary.",
            "type":"string"
        },
        "itineraryXid":{
            "description":"Contains the XID for the itinerary.",
            "type":"string"
        },
        "itineraryName":{
            "description":"Contains the name for the itinerary.",
            "type":"string"
        },
        "description":{
            "description":"Contains text describing the itinerary.",
            "type":"string"
        },
        "minWeight":{
            "description":"Contains the minimum weight for the shipment on the itinerary.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxWeight":{
            "description":"Contains the maximum weight for the shipment on the itinerary.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "minVolume":{
            "description":"Contains the minimum volume for the shipment on the itinerary.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"Contains the maximum volume for the shipment on the itinerary.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "corporationProfileGid":{
            "description":"Contains the GID for the corporation profile used for the itinerary.",
            "type":"string"
        },
        "calendarGid":{
            "description":"Contains the GID for the calendar.",
            "type":"string"
        },
        "xLaneGid":{
            "description":"Contains the GID for the entity. It is created by concatenating the Domain Name,\".\" and the XID.",
            "type":"string"
        },
        "isMultiStop":{
            "description":"Describes whether the itinerary contains more than one stop. If so, this column contains a Y for yes; if not it contains an N for no.",
            "type":"boolean"
        },
        "perspective":{
            "description":"The perspective determines whether the itinerary is used for buy or sell shipment services. Perspective options include All (used for Buy and Sell), Buy, Sell.",
            "type":"string"
        },
        "totalCost":{
            "description":"N/A",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalTransitTime":{
            "description":"N/A",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "useDeconsolidationPool":{
            "description":"Orders matched to this itinerary may use a deconsolidation pool on the destination.",
            "type":"boolean"
        },
        "useConsolidationPool":{
            "description":"Orders matched to this itinerary may use a consolidation pool on the source.",
            "type":"boolean"
        },
        "minStopoffWeight":{
            "description":"Order bundles less than this weight will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxPoolWeight":{
            "description":"The Maximum Pool Weight field identifies the highest weight for shipments that use the pool. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a pool. If one field is populated, the order needs to be less than this value in order to be routed to a pool. If both are NULL, all orders qualify to be routed to a pool.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxDistBtwDelvs":{
            "description":"The maximum distance between deliveries is used to limit the distance between delivery stops. If the distance between two delivery stops exceed this value, orders are not paired.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalStopsConstraint":{
            "description":"Specifies the maximum number of stops on a multi-stop shipment derived from this itinerary.",
            "type":"number",
            "format":"int32"
        },
        "minTlWeight":{
            "description":"This is the minimum weight to make up a nice truckload. It is also used as the minimum weight to go through a pool.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "minStopoffVolume":{
            "description":"Order bundles less than this volume will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools. When doing pool drop swapping, only pool drop shipments whose volume is bigger than this value are tried.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxPoolVolume":{
            "description":"The maximum volume to go through a pool.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxSmallDirectVolume":{
            "description":"After pool swapping, the system attempts to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This volume guides the algorithm to only pull of the one that is smaller than this volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxSmallDirectWeight":{
            "description":"After pool swapping, the system tries to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This weight guides the algorithm to only pull of the one that is smaller than this weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxXdockWeight":{
            "description":"The Max Cross Dock Weight field identifies the highest weight for shipments that use the cross dock. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a cross dock. If one field is populated, the order needs to be less than this value in order to be routed to a cross dock. If both are NULL, all orders qualify to be routed to a cross dock.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxXdockVolume":{
            "description":"The Max Cross Dock Volume field identifies the highest volume for shipments that use the cross dock.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "minTlUsagePercentage":{
            "description":"The percentage of usage to be used to determine whether a TL is full in bulk plan. This will guide whether direct shipment be kept without routing to pool. It also determines whether pool shipments be kept without routing to xdock.",
            "type":"number",
            "format":"double"
        },
        "minTlVolume":{
            "description":"This is the minimum volume to make up a nice truckload. It is also used as the minimum volume to go through a pool",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isDestBundlePrefered":{
            "description":"If this is selected, when going through the deconsolidation pool process, if there is a cross dock on this itinerary, two or more order bundles have the same destination will not route to the deconsolidation pool. It will route to cross dock later for consolidation at the cross dock and directly go to the destination.",
            "type":"boolean"
        },
        "hazmatModeGid":{
            "description":"The GID for the hazardous transport mode. It can be used to differentiate between goods from different orders that can be consolidated into one shipment for one or more legs of the trip.",
            "type":"string"
        },
        "rank":{
            "description":"N/A",
            "type":"number",
            "format":"int32"
        },
        "itineraryType":{
            "description":"By default, the Itinerary Type field displays Active which means that the itinerary can be used in shipment planning. Choose Inactive if you do not want this itinerary to be considered when building shipments. You can also choose Manual which means the itinerary should not be considered when running the Create Shipment - Bulk Plan, Direct, or Calculate Best Direct Cost actions. However, the itinerary is considered when running the Direct - Show Routing Options action.",
            "type":"string"
        },
        "isRule11":{
            "description":"N/A",
            "type":"boolean"
        },
        "incoTermProfileGid":{
            "description":"The GID for the INCO Term profile. The Incoterm Profile can be used to constrain the itinerary as a valid choice for shipment planning for any order that has the same Incoterm attributes as the profile. Note: If you use this field, you can also specify a Payment Method code on each leg of the itinerary which is then copied to the shipment that is built for that leg (overriding any Payment Method code defined on the order base).",
            "type":"string"
        },
        "depotProfileGid":{
            "description":"The GID for the depot profile. The depot profile defines the lane and Source and/or Destination Depot Location that are considered during planning for service providers that start and end at depot locations.",
            "type":"string"
        },
        "pickupStopsConstraints":{
            "description":"The total number of pickup stops for a multistop shipment. It is usually set to be the max of Pickup Stops Constraints of all valid rate offering. This helps multistop performance.",
            "type":"number",
            "format":"int32"
        },
        "deliveryStopsConstraints":{
            "description":"The total number of pickup stops for a multistop shipment. It is usually set to be the maximum of the Delivery Stops Constraints of all valid rate offering. This help multistop performance.",
            "type":"number",
            "format":"int32"
        },
        "maxDistBtwPickups":{
            "description":"In some cases, it is more expensive to ship to a cross-dock than to ship direct because of the distance from the source to the cross-dock. To limit the distance you want shipments to travel to a cross-dock, enter a numeric value in the Maximum Distance between Pickups/Deliveries fields. If the distance between two pickup or delivery stops exceed this value, orders are not paired.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "radiusForPickups":{
            "description":"The distance from any pickup stop to the root bundle's source location can not exceed this distance. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "radiusPercentageForPickups":{
            "description":"The distance from any pickup stop to the source location divided by the distance cannot exceed this percentage. ",
            "type":"number",
            "format":"double"
        },
        "radiusForDelvs":{
            "description":"The maximum radial - straight line distance - from the source to each delivery stop location that can not be exceeded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "radiusPercentageForDelvs":{
            "description":"The maximum radial percentage distance from the source to each delivery stop location that can not be exceeded.",
            "type":"number",
            "format":"double"
        },
        "isMatchDeconsolPoolToDest":{
            "description":"The Match Deconsol Pool to Dest check box sets the pool logic so that it matches orders to deconsolidation pools based on order's destination locations. If this is not selected, Oracle Transportation Management matches orders to deconsolidation pools according to the order's source location.",
            "type":"boolean"
        },
        "isMatchConsolPoolToSrc":{
            "description":"The Match Deconsol Pool to Src check box sets the pool logic so that it matches orders to deconsolidation pools based on order's source location. If it is selected pool logic matches orders to consolidation pools based on order's source locations. If the check box is cleared, Oracle Transportation Management matches orders to consolidation pools according to the order's destination locations.",
            "type":"boolean"
        },
        "paymentMethodProfileGid":{
            "description":"The list of compatible payment methods for the itinerary.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "legs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : legs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxDistBtwDelvs

The maximum distance between deliveries is used to limit the distance between delivery stops. If the distance between two delivery stops exceed this value, orders are not paired.

Match All

The maximum distance between deliveries is used to limit the distance between delivery stops. If the distance between two delivery stops exceed this value, orders are not paired.

Show Source

• object amountType

{
    "description":"The maximum distance between deliveries is used to limit the distance between delivery stops. If the distance between two delivery stops exceed this value, orders are not paired.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxDistBtwPickups

In some cases, it is more expensive to ship to a cross-dock than to ship direct because of the distance from the source to the cross-dock. To limit the distance you want shipments to travel to a cross-dock, enter a numeric value in the Maximum Distance between Pickups/Deliveries fields. If the distance between two pickup or delivery stops exceed this value, orders are not paired.

Match All

In some cases, it is more expensive to ship to a cross-dock than to ship direct because of the distance from the source to the cross-dock. To limit the distance you want shipments to travel to a cross-dock, enter a numeric value in the Maximum Distance between Pickups/Deliveries fields. If the distance between two pickup or delivery stops exceed this value, orders are not paired.

Show Source

• object amountType

{
    "description":"In some cases, it is more expensive to ship to a cross-dock than to ship direct because of the distance from the source to the cross-dock. To limit the distance you want shipments to travel to a cross-dock, enter a numeric value in the Maximum Distance between Pickups/Deliveries fields. If the distance between two pickup or delivery stops exceed this value, orders are not paired.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxPoolVolume

The maximum volume to go through a pool.

Match All

The maximum volume to go through a pool.

Show Source

• object amountType

{
    "description":"The maximum volume to go through a pool.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxPoolWeight

The Maximum Pool Weight field identifies the highest weight for shipments that use the pool. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a pool. If one field is populated, the order needs to be less than this value in order to be routed to a pool. If both are NULL, all orders qualify to be routed to a pool.

Match All

The Maximum Pool Weight field identifies the highest weight for shipments that use the pool. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a pool. If one field is populated, the order needs to be less than this value in order to be routed to a pool. If both are NULL, all orders qualify to be routed to a pool.

Show Source

• object amountType

{
    "description":"The Maximum Pool Weight field identifies the highest weight for shipments that use the pool. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a pool. If one field is populated, the order needs to be less than this value in order to be routed to a pool. If both are NULL, all orders qualify to be routed to a pool.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxSmallDirectVolume

After pool swapping, the system attempts to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This volume guides the algorithm to only pull of the one that is smaller than this volume.

Match All

After pool swapping, the system attempts to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This volume guides the algorithm to only pull of the one that is smaller than this volume.

Show Source

• object amountType

{
    "description":"After pool swapping, the system attempts to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This volume guides the algorithm to only pull of the one that is smaller than this volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxSmallDirectWeight

After pool swapping, the system tries to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This weight guides the algorithm to only pull of the one that is smaller than this weight.

Match All

After pool swapping, the system tries to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This weight guides the algorithm to only pull of the one that is smaller than this weight.

Show Source

• object amountType

{
    "description":"After pool swapping, the system tries to pull off the orders that are close to parcel weight and ship direct, if the overall solution is cheaper. This weight guides the algorithm to only pull of the one that is smaller than this weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxVolume

Contains the maximum volume for the shipment on the itinerary.

Match All

Contains the maximum volume for the shipment on the itinerary.

Show Source

• object amountType

{
    "description":"Contains the maximum volume for the shipment on the itinerary.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

Contains the maximum weight for the shipment on the itinerary.

Match All

Contains the maximum weight for the shipment on the itinerary.

Show Source

• object amountType

{
    "description":"Contains the maximum weight for the shipment on the itinerary.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxXdockVolume

The Max Cross Dock Volume field identifies the highest volume for shipments that use the cross dock.

Match All

The Max Cross Dock Volume field identifies the highest volume for shipments that use the cross dock.

Show Source

• object amountType

{
    "description":"The Max Cross Dock Volume field identifies the highest volume for shipments that use the cross dock.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxXdockWeight

The Max Cross Dock Weight field identifies the highest weight for shipments that use the cross dock. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a cross dock. If one field is populated, the order needs to be less than this value in order to be routed to a cross dock. If both are NULL, all orders qualify to be routed to a cross dock.

Match All

The Max Cross Dock Weight field identifies the highest weight for shipments that use the cross dock. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a cross dock. If one field is populated, the order needs to be less than this value in order to be routed to a cross dock. If both are NULL, all orders qualify to be routed to a cross dock.

Show Source

• object amountType

{
    "description":"The Max Cross Dock Weight field identifies the highest weight for shipments that use the cross dock. If both of the max weight and volume fields are populated, the order needs to be less than these two values in order to be routed to a cross dock. If one field is populated, the order needs to be less than this value in order to be routed to a cross dock. If both are NULL, all orders qualify to be routed to a cross dock.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minStopoffVolume

Order bundles less than this volume will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools. When doing pool drop swapping, only pool drop shipments whose volume is bigger than this value are tried.

Match All

Order bundles less than this volume will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools. When doing pool drop swapping, only pool drop shipments whose volume is bigger than this value are tried.

Show Source

• object amountType

{
    "description":"Order bundles less than this volume will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools. When doing pool drop swapping, only pool drop shipments whose volume is bigger than this value are tried.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minStopoffWeight

Order bundles less than this weight will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools.

Match All

Order bundles less than this weight will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools.

Show Source

• object amountType

{
    "description":"Order bundles less than this weight will always go through a pool if the origin/destination of the order bundles fall into consolidation/deconsolidation pools.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minTlVolume

This is the minimum volume to make up a nice truckload. It is also used as the minimum volume to go through a pool

Match All

This is the minimum volume to make up a nice truckload. It is also used as the minimum volume to go through a pool

Show Source

• object amountType

{
    "description":"This is the minimum volume to make up a nice truckload. It is also used as the minimum volume to go through a pool",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minTlWeight

This is the minimum weight to make up a nice truckload. It is also used as the minimum weight to go through a pool.

Match All

This is the minimum weight to make up a nice truckload. It is also used as the minimum weight to go through a pool.

Show Source

• object amountType

{
    "description":"This is the minimum weight to make up a nice truckload. It is also used as the minimum weight to go through a pool.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minVolume

Contains the minimum volume for the shipment on the itinerary.

Match All

Contains the minimum volume for the shipment on the itinerary.

Show Source

• object amountType

{
    "description":"Contains the minimum volume for the shipment on the itinerary.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minWeight

Contains the minimum weight for the shipment on the itinerary.

Match All

Contains the minimum weight for the shipment on the itinerary.

Show Source

• object amountType

{
    "description":"Contains the minimum weight for the shipment on the itinerary.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : radiusForDelvs

The maximum radial - straight line distance - from the source to each delivery stop location that can not be exceeded.

Match All

The maximum radial - straight line distance - from the source to each delivery stop location that can not be exceeded.

Show Source

• object amountType

{
    "description":"The maximum radial - straight line distance - from the source to each delivery stop location that can not be exceeded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : radiusForPickups

The distance from any pickup stop to the root bundle's source location can not exceed this distance.

Match All

The distance from any pickup stop to the root bundle's source location can not exceed this distance.

Show Source

• object amountType

{
    "description":"The distance from any pickup stop to the root bundle's source location can not exceed this distance. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalCost

N/A

Match All

N/A

Show Source

• object currencyType

{
    "description":"N/A",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalTransitTime

N/A

Match All

N/A

Show Source

• object amountType

{
    "description":"N/A",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itineraries.legs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• capacityOverrides: capacityOverrides
• domainName: string
  Database domain where this data is stored.
• flexCommodityProfilelists: flexCommodityProfilelists
• interimPoints: interimPoints
• involvedParties: involvedParties
• legGid: string
  Contains the GID for a leg on the itinerary.
• links: array links
  Read Only: true
• schedules: schedules
• sequenceNo: number (int32)
  Sequence number for the itinerary leg.

{
    "properties":{
        "legGid":{
            "description":"Contains the GID for a leg on the itinerary.",
            "type":"string"
        },
        "sequenceNo":{
            "description":"Sequence number for the itinerary leg.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "interimPoints":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.interimPoints"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "flexCommodityProfilelists":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.flexCommodityProfilelists"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "schedules":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.schedules"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "capacityOverrides":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/itineraries.legs.capacityOverrides"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : capacityOverrides

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.capacityOverrides"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : flexCommodityProfilelists

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.flexCommodityProfilelists"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : interimPoints

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.interimPoints"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schedules

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itineraries.legs.schedules"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itineraries.legs.capacityOverrides"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• capacityOverrideGid: string
  The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "capacityOverrideGid":{
            "description":"The GID for the capacity override details related to this itinerary leg. The capacity override allows you to model specific weight/volume restrictions by transport mode or equipment that can be assigned to any itinerary leg to control whether a shipment can be planned for that leg. For example, some countries or regions have specific capacity restrictions such as bridges that have maximum weight limits. By creating a capacity override and assigning it to a specific itinerary leg, Oracle Transportation Management will override the equipment capacity. For example, if an equipment has a capacity of 30000 pounds, but the capacity override says 27000 pounds, then the system will not plan more than 27000 pounds in the equipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itineraries.legs.flexCommodityProfilelists"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• flexCommodityProfileGid: string
  Contains the GID for the flex commodity profile for the leg.
• links: array links
  Read Only: true

{
    "properties":{
        "flexCommodityProfileGid":{
            "description":"Contains the GID for the flex commodity profile for the leg.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itineraries.legs.interimPoints"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  Contains the GID for the location for the leg.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• seqNo: number (int32)
  Contains the sequence number for the leg.
• specialServiceGid: string
  The special service needed for this interim point. It will be added to the corresponding shipment stop special service.

{
    "properties":{
        "seqNo":{
            "description":"Contains the sequence number for the leg.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"Contains the GID for the location for the leg. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "specialServiceGid":{
            "description":"The special service needed for this interim point. It will be added to the corresponding shipment stop special service.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itineraries.legs.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The GID for the communication method.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The GID for the involved party contact.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The GID for the involved party qualifier related to the itinerary leg.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier related to the itinerary leg.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The GID for the involved party contact. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The GID for the communication method.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itineraries.legs.schedules"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• repetitionScheduleGid: string
  The GID for the repetition schedule (ground schedule) being assigned to the itinerary leg.

{
    "properties":{
        "repetitionScheduleGid":{
            "description":"The GID for the repetition schedule (ground schedule) being assigned to the itinerary leg.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method for the involved party listed on the order base.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The involved party contact for the qualifier listed on the order base.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The involved party qualifier GID.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The involved party qualifier GID.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The involved party contact for the qualifier listed on the order base. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method for the involved party listed on the order base.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.legConstraints

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.legConstraints"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.legConstraints

Type: object

Show Source

• buyRateGeoGid: string
  The buy rate detail GID used as a planning constraint.
• buyRateOfferingGid: string
  The buy rate offering GID used as a planning constraint.
• domainName: string
  Database domain where this data is stored.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  The equipment group GID used as a planning constraint.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentGroupProfileGid: string
  The equipment group profile GID used as a planning constraint.
• legClassificationGid: string
  The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.
• links: array links
  Read Only: true
• modeProfileGid: string
  The rate service profile GID used as a planning constraint.
• rateServiceProfileGid: string
  The service provider profile GID used as a planning constraint.
• sellRateGeoGid: string
  The sell rate detail GID used as a planning constraint.
• sellRateOfferingGid: string
  The sell rate offering GID used as a planning constraint.
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The mode profile GID used as a planning constraint.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprovProfileGid: string
  The service provider GID used as a planning constraint.
• transportModeGid: string
  The transport mode GID used as a planning constraint.

{
    "properties":{
        "legClassificationGid":{
            "description":"The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.",
            "type":"string"
        },
        "buyRateOfferingGid":{
            "description":"The buy rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateOfferingGid":{
            "description":"The sell rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "buyRateGeoGid":{
            "description":"The buy rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateGeoGid":{
            "description":"The sell rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"The equipment group GID used as a planning constraint. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "equipmentGroupProfileGid":{
            "description":"The equipment group profile GID used as a planning constraint.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The transport mode GID used as a planning constraint.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The mode profile GID used as a planning constraint. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "servprovProfileGid":{
            "description":"The service provider GID used as a planning constraint.",
            "type":"string"
        },
        "rateServiceProfileGid":{
            "description":"The service provider profile GID used as a planning constraint.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The rate service profile GID used as a planning constraint.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines

Type: object

Show Source

• allocations: allocations
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributes: attributes
• bufferLocation: bufferLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• bufferLocationGid: string
  The buffer location GID. A buffer location can be an stock holding location that the order release ship to location will be built to. A subsequent order release will be created to move from this buffer location to the planned ship to location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• declaredValue: declaredValue
  The declared value contains the stated value for the order base line item.
• deliveryIsAppt: boolean
  Indicates if the early/late delivery times are appointment times.
• destLocationGid: string
  The destination location GID for the delivery location associated with this order base line.
• domainName: string
  Database domain where this data is stored.
• earlyDeliveryDate: earlyDeliveryDate
  The earliest date when the item can be delivered.
• earlyPickupDate: earlyPickupDate
  The earliest date when the item can be picked up.
• equipmentRefUnits: equipmentRefUnits
• initialItem: initialItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• initialItemGid: string
  Can be used to define the substitution.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedParties: involvedParties
• isAutoRelease: boolean
  A Y/N indicator to create the order release line from the order base line when it is initially created.
• isShippable: boolean
  A Y/N indicator defining if the order base line is ready to be shipped by creating an order release for it.
• isSplitAllowed: boolean
  A true or false flag to define whether the line item can be split during the order release or shipment.
• lateDeliveryDate: lateDeliveryDate
  The latest date when the item can be picked delivered.
• latePickupDate: latePickupDate
  The latest date when the item can be picked up.
• links: array links
  Read Only: true
• loadPoint: string
  The specific loading location for the source location on the line.
• numLayersPerShipUnit: number (int64)
  The number of layers for the transportation handling unit defined on the order base line. This allows you to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.
• obLineGid: string
  The GID for the order base line associated with the order base.
• obLineXid: string
  The XID for the order base line.
• packagedCount: number (int64)
  The package count associated with the packaged item for this line. For example, 10 cases of product A.
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item GID defining the item associated to this order base line.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packageRefUnits: packageRefUnits
• packagingUnitCount: number (int64)
  The packaging unit count associated to the packaging unit for this order base line.
• packagingUnitGid: string
  The packaging unit (considered an inner pack to the packaged item level) for this order base line.
• pickupIsAppt: boolean
  Indicates if the early/late pickup times are appointment times.
• planFromLoadPoint: string
  The specific loading location for the plan from location on the line.
• planFromLocationGid: string
  The plan from location GID can define a location other than the source location of the line to beginning planning transport.
• planToLocationGid: string
  The plan to location GID can define a location other than the destination location of the line to terminate planning transport.
• planToUnloadPoint: string
  The specific unloading location for the plan to location on the line.
• quantityPerLayer: number (int64)
  The quantity per layer for the transportation handling unit defined on the order base line. This allows you to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table
• readyQuantity: number (int64)
  The quantity of the line that is ready to be released.
• refnums: refnums
• releasedCount: number (int64)
  Read Only: true

  The total released package count that has already been released against this order base line.
• releasedVolume: releasedVolume
  Read Only: true

  The total volume that has already been released against this order base line.
• releasedWeight: releasedWeight
  Read Only: true

  The total released weight that has already been released against this order base line.
• releaseInstructions: releaseInstructions
• remarks: remarks
• roundingInstruction: string
  How the releasing logic will look to handle rounding when calculating the released values.
• roundTo: string
  Round to packaging unit quantity (PUQ), layer (LAY), or transport handling unit (THU).
• sourceLocationGid: string
  The source location GID for the pickup location associated with this order base line.
• statuses: statuses
• tag1: string
  Additional information about the item. Like the color or size code etc.
• tag2: string
  Additional information about the item. Like the color or size code etc.
• tag3: string
  Additional information about the item. Like the color or size code etc.
• tag4: string
  Additional information about the item. Like the color or size code etc.
• thuProfileGid: string
  The transport handling unit profile (list of valid THUs for this order line) that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged Item table.
• transportHandlingUnitGid: string
  The transport handling unit that is to be used when building the order release ship unit. If defined here, it will take precedence to the data that is defined on the static packaged item table.
• unloadPoint: string
  The specific unloading location for the delivery location on the line.
• volume: volume
  The volume of the packaged items for this line.
• weight: weight
  The weight of the packaged items for this line.

{
    "properties":{
        "obLineGid":{
            "description":"The GID for the order base line associated with the order base.",
            "type":"string"
        },
        "obLineXid":{
            "description":"The XID for the order base line.",
            "type":"string"
        },
        "sourceLocationGid":{
            "description":"The source location GID for the pickup location associated with this order base line.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The destination location GID for the delivery location associated with this order base line.",
            "type":"string"
        },
        "tag1":{
            "description":"Additional information about the item. Like the color or size code etc.",
            "type":"string"
        },
        "tag2":{
            "description":"Additional information about the item. Like the color or size code etc.",
            "type":"string"
        },
        "tag3":{
            "description":"Additional information about the item. Like the color or size code etc.",
            "type":"string"
        },
        "tag4":{
            "description":"Additional information about the item. Like the color or size code etc.",
            "type":"string"
        },
        "isSplitAllowed":{
            "description":"A true or false flag to define whether the line item can be split during the order release or shipment.",
            "type":"boolean"
        },
        "weight":{
            "description":"The weight of the packaged items for this line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the packaged items for this line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"The declared value contains the stated value for the order base line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "earlyPickupDate":{
            "description":"The earliest date when the item can be picked up.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latePickupDate":{
            "description":"The latest date when the item can be picked up.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "earlyDeliveryDate":{
            "description":"The earliest date when the item can be delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lateDeliveryDate":{
            "description":"The latest date when the item can be picked delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "packagedItemGid":{
            "description":"The packaged item GID defining the item associated to this order base line. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "isAutoRelease":{
            "description":"A Y/N indicator to create the order release line from the order base line when it is initially created.",
            "type":"boolean"
        },
        "packagedCount":{
            "description":"The package count associated with the packaged item for this line. For example, 10 cases of product A.",
            "type":"number",
            "format":"int64"
        },
        "loadPoint":{
            "description":"The specific loading location for the source location on the line.",
            "type":"string"
        },
        "unloadPoint":{
            "description":"The specific unloading location for the delivery location on the line.",
            "type":"string"
        },
        "pickupIsAppt":{
            "description":"Indicates if the early/late pickup times are appointment times.",
            "type":"boolean"
        },
        "deliveryIsAppt":{
            "description":"Indicates if the early/late delivery times are appointment times.",
            "type":"boolean"
        },
        "planFromLocationGid":{
            "description":"The plan from location GID can define a location other than the source location of the line to beginning planning transport.",
            "type":"string"
        },
        "planFromLoadPoint":{
            "description":"The specific loading location for the plan from location on the line.",
            "type":"string"
        },
        "planToLocationGid":{
            "description":"The plan to location GID can define a location other than the destination location of the line to terminate planning transport.",
            "type":"string"
        },
        "planToUnloadPoint":{
            "description":"The specific unloading location for the plan to location on the line.",
            "type":"string"
        },
        "numLayersPerShipUnit":{
            "description":"The number of layers for the transportation handling unit defined on the order base line. This allows you to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.",
            "type":"number",
            "format":"int64"
        },
        "isShippable":{
            "description":"A Y/N indicator defining if the order base line is ready to be shipped by creating an order release for it.",
            "type":"boolean"
        },
        "quantityPerLayer":{
            "description":"The quantity per layer for the transportation handling unit defined on the order base line. This allows you to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table",
            "type":"number",
            "format":"int64"
        },
        "releasedWeight":{
            "description":"The total released weight that has already been released against this order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "releasedVolume":{
            "description":"The total volume that has already been released against this order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "releasedCount":{
            "description":"The total released package count that has already been released against this order base line.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "packagingUnitGid":{
            "description":"The packaging unit (considered an inner pack to the packaged item level) for this order base line.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count associated to the packaging unit for this order base line.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit that is to be used when building the order release ship unit. If defined here, it will take precedence to the data that is defined on the static packaged item table.",
            "type":"string"
        },
        "initialItemGid":{
            "description":"Can be used to define the substitution. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "initialItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "roundingInstruction":{
            "description":"How the releasing logic will look to handle rounding when calculating the released values.",
            "type":"string"
        },
        "roundTo":{
            "description":"Round to packaging unit quantity (PUQ), layer (LAY), or transport handling unit (THU).",
            "type":"string"
        },
        "bufferLocationGid":{
            "description":"The buffer location GID. A buffer location can be an stock holding location that the order release ship to location will be built to. A subsequent order release will be created to move from this buffer location to the planned ship to location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "bufferLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "thuProfileGid":{
            "description":"The transport handling unit profile (list of valid THUs for this order line) that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged Item table.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "readyQuantity":{
            "description":"The quantity of the line that is ready to be released.",
            "type":"number",
            "format":"int64"
        },
        "attributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.attributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packageRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.packageRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "releaseInstructions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.releaseInstructions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "allocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.allocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.allocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.attributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : bufferLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : declaredValue

The declared value contains the stated value for the order base line item.

Match All

The declared value contains the stated value for the order base line item.

Show Source

• object currencyType

{
    "description":"The declared value contains the stated value for the order base line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : earlyDeliveryDate

The earliest date when the item can be delivered.

Match All

The earliest date when the item can be delivered.

Show Source

• object dateTimeType

{
    "description":"The earliest date when the item can be delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : earlyPickupDate

The earliest date when the item can be picked up.

Match All

The earliest date when the item can be picked up.

Show Source

• object dateTimeType

{
    "description":"The earliest date when the item can be picked up.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : initialItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lateDeliveryDate

The latest date when the item can be picked delivered.

Match All

The latest date when the item can be picked delivered.

Show Source

• object dateTimeType

{
    "description":"The latest date when the item can be picked delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : latePickupDate

The latest date when the item can be picked up.

Match All

The latest date when the item can be picked up.

Show Source

• object dateTimeType

{
    "description":"The latest date when the item can be picked up.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : packageRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.packageRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : releasedVolume

Read Only: true

The total volume that has already been released against this order base line.

Match All

The total volume that has already been released against this order base line.

Show Source

• object amountType

{
    "description":"The total volume that has already been released against this order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : releasedWeight

Read Only: true

The total released weight that has already been released against this order base line.

Match All

The total released weight that has already been released against this order base line.

Show Source

• object amountType

{
    "description":"The total released weight that has already been released against this order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : releaseInstructions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.releaseInstructions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The volume of the packaged items for this line.

Match All

The volume of the packaged items for this line.

Show Source

• object amountType

{
    "description":"The volume of the packaged items for this line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight of the packaged items for this line.

Match All

The weight of the packaged items for this line.

Show Source

• object amountType

{
    "description":"The weight of the packaged items for this line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.allocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.allocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.allocations

Type: object

Show Source

• allocationBase: allocationBase
• allocSeqNo: number (int64)
  No description.
• baseCost: baseCost
  No description.
• details: details
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• links: array links
  Read Only: true
• orderBase: orderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderBaseGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• privateCost: privateCost
  No description.
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• totalAllocLineCost: totalAllocLineCost
  No description.

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "orderBaseGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "privateCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "baseCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalAllocLineCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packagedItemGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "allocationBase":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.allocations.allocationBase"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.allocations.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocationBase

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.allocations.allocationBase"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : baseCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.allocations.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : privateCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : totalAllocLineCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.allocations.allocationBase

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.allocations.allocationBase"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.allocations.allocationBase

Type: object

Show Source

• allocatedCost: allocatedCost
  No description.
• allocSeqNo: number (int64)
  No description.
• allocTypeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• invoice: invoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• invoiceGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• parentInvoice: parentInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentInvoiceGid: string
  If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipGroup: shipGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipGroupGid: string
  Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
  group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• timestamp: timestamp
  No description.
• voucher: voucher
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voucherGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "invoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"If populated, the INVOICE_GID indicates that this alllocation is for a child invoice.  This column indicates the parent invoice of the entire consolidation that was allocated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "voucherGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voucher":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/vouchers"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : invoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : parentInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : shipGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : timestamp

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : voucher

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object vouchers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/vouchers"
        }
    ],
    "readOnly":true
}

Nested Schema : bills

Type: object

Show Source

• allocations: allocations
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency2: attributeCurrency2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency3: attributeCurrency3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• baseCharge: baseCharge
  The Base Charge is the sum of the shipping charges for the invoice.
• consolidationType: string
  The value is set based on the invoice type involved - there are three consolidation types- STANDARD for a stand-alone invoice, PARENT for a parent invoice (for example, a consolidation invoice), or CHILD for a child invoice.
• correctionCodeId: string
  Correction code identifier.
• currencyGid: string
  The GID for currency.
• customerVatRegNoGid: string
  The Customer VAT Registration ID is the VAT tax ID for the customer.
• dateReceived: dateReceived
  The date the invoice was received.
• destCountryCode3Gid: string
  The destination country code GID.
• destStationCity: string
  The city in which the related shipment ends.
• destStationFsac: string
  The FSAC code for the station in which the related shipment ended.
• destStationPostalCode: string
  The postal code in which the related shipment ended.
• destStationProvinceCode: string
  The province code in which the related shipment ended.
• destStationSplc: string
  The SPLC code for the destination of the shipment which relates to this invoice.
• discountAmount: discountAmount
  The total dollar amount of any discounts applied to the invoice.
• discountDaysDue: number (int32)
  The number of days in the terms discount period by which payment is due if the terms of the discount are to be earned.
• discountDueDate: discountDueDate
  The date that the payment must be made by in order for the discount to be earned.
• discountPercentage: number (double)
  Either a specific amount for the discount or a percentage to be used for the discount.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• endDate: endDate
  The end range for which this invoice was generated.
• enteredByGlUserGid: string
  Identifies which GL user entered the invoice into the system.
• equipmentDetails: equipmentDetails
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
• glDate: glDate
  GL Date for the invoice as set by agent or manual action.
• incoTermGid: string
  The terms of sale for this particular invoice.
• insertDate: insertDate
  Read Only: true

  insert date
• invConsConstraintSetGid: string
  Constraint Set ID is used for creating a consolidated invoice/bill. This will be used for identifying the parent invoice/bill when you add more invoices/bills with the same constraint set.
• invoiceDate: invoiceDate
  The date of the invoice.
• invoiceGid: string
  The GID for the invoice.
• invoiceNumber: string
  Indicates the number that was assigned to the invoice.
• invoiceRuleGid: string
  The rule ID used for generating this invoice/bill.
• invoiceServiceCodeGid: string
  The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE.
• invoiceSource: string
  Valid values are G, I, M.
• invoiceType: string
  Indicates whether this is a bill or an invoice (valid values are 'I' or 'B'). INVOICE_TYPE indicates whether this is a bill or an invoice (valid values are 'I' or 'B').
• invoiceXid: string
  The XID for the invoice.
• invoicingProcess: string
  N/A
• involvedParties: involvedParties
• isCreditNote: boolean
  Indicates if this invoice is a credit note
• isFixedCost: boolean
  The Fixed Cost check box allows you to override the amount due calculation. When checked the amount due that you enter will be used regardless of the base and other charges.
• isHazardous: boolean
  Indicator for identifying whether the invoiced shipment was or was not identified as carrying hazardous or dangerous goods.
• isPassThrough: boolean
  The Pass Through check box allows to the invoice to be approved for payment without being matched to a shipment.
• isTemperatureControl: boolean
  Indicator for identifying whether the invoiced shipment was or was not identified as requiring temperature control.
• isVatAnalysisFixed: boolean
  Indicates if the VAT Analysis is fixed (user entered) and the system should not try to calculate it.
• letterOfCreditExpDate: letterOfCreditExpDate
  The date until which the letter of credit is in effect. After this date, the letter of credit expires.
• letterOfCreditIssueDate: letterOfCreditIssueDate
  The date that the letter of credit was issued.
• letterOfCreditNumber: string
  The identification number of the letter of credit.
• lineItems: lineItems
• links: array links
  Read Only: true
• netAmountDue: netAmountDue
  The net amount that is due for the invoice.
• netAmtDueWithTax: netAmtDueWithTax
  The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).
• netDueDate: netDueDate
  The date on which the net amount for the invoice is due.
• notes: notes
• orderReleases: orderReleases
• originalInvoice: originalInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property originalInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• originalInvoiceGid: string
  For supplemental bills. This references the original bill.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• originCountryCode3Gid: string
  The origin country code GID.
• originStationCity: string
  The city in which the related shipment began.
• originStationFsac: string
  The FSAC code for the station in which the related shipment began.
• originStationPostalCode: string
  The postal code in which the related shipment began.
• originStationProvinceCode: string
  The province code in which the related shipment began.
• originStationSplc: string
  The SPLC code for the station in which the related shipment began.
• otherCharge: otherCharge
  The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.
• parentInvoice: parentInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentInvoiceGid: string
  The parent invoice GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• paymentMethodCodeGid: string
  The method of payment that is expected for the invoice. Examples include: check, cash on deliver, credit card and electronic funds transfer.
• ports: ports
• protectiveServices: protectiveServices
• railDate: railDate
  The rail date is the date when a container gets put on rail car.
• refnums: refnums
• remarks: remarks
• routes: routes
• sailCutoffDate: sailCutoffDate
  The sail cutoff date is the latest date in which you can get your cargo onto the vessel.
• sailDate: sailDate
  The sail date is the date the vessel sails.
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovAliasQualGid: string
  Identifies the service provider qualifier (such as SCAC), which is then associated with the value in servprov_alias_value.
• servprovAliasValue: string
  Identifies service provider that handled the shipment related to the invoice. The qualifier servprov_alias_qual_gid qualifies the value, which can be a scec code, or another descriptor for the service provider.
• servprovGid: string
  The GID for the service provider.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprovVatRegNoGid: string
  The service provider VAT Registration ID is the VAT tax ID for the service provider.
• shipments: shipments
• startDate: startDate
  The start range for which this invoice was generated.
• statuses: statuses
• stops: stops
• summaries: summaries
• summaryDetails: summaryDetails
• supplyCountryCode3Gid: string
  The Supply Country Code ID represents the country that the goods are coming from.
• supplyProvinceVatRegs: supplyProvinceVatRegs
• texts: texts
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
• userDefined2IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
• userDefined3IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
• userDefined4IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
• userDefined5IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
• vatAnalyses: vatAnalyses
• vatExemptValue: string
  The VAT Exempt field is used when the bill is exempt from the tax. When it is checked, you need to specify whether the bill is Exempt with Credit or Exempt without Credit.
• vesOpServprovAliasQualGid: string
  The vessel operator service provider alias qualifier GID.
• vesOpServprovAliasValue: string
  Service provider alias of the vessel operator.
• vesselCode: string
  The vessel that was used for the shipment that relates to the invoice.
• vesselCodeQualifier: string
  The qualifier for the vessel.
• vesselCountryCode3Gid: string
  The vessel country code GID.
• vesselGid: string
  Vessel ID for the invoice.
• voyageNumber: string
  The number of the voyage that relates to the shipment for which this invoice is being created.

{
    "properties":{
        "invoiceGid":{
            "description":"The GID for the invoice.",
            "type":"string"
        },
        "invoiceXid":{
            "description":"The XID for the invoice.",
            "type":"string"
        },
        "invoiceType":{
            "description":"Indicates whether this is a bill or an invoice (valid values are 'I' or 'B'). INVOICE_TYPE indicates whether this is a bill or an invoice (valid values are 'I' or 'B').",
            "type":"string"
        },
        "invoiceSource":{
            "description":"Valid values are G, I, M.",
            "type":"string"
        },
        "enteredByGlUserGid":{
            "description":"Identifies which GL user entered the invoice into the system.",
            "type":"string"
        },
        "invoiceNumber":{
            "description":"Indicates the number that was assigned to the invoice.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"Identifies the service provider qualifier (such as SCAC), which is then associated with the value in servprov_alias_value.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"Identifies service provider that handled the shipment related to the invoice. The qualifier servprov_alias_qual_gid qualifies the value, which can be a scec code, or another descriptor for the service provider.",
            "type":"string"
        },
        "correctionCodeId":{
            "description":"Correction code identifier.",
            "type":"string"
        },
        "invoiceDate":{
            "description":"The date of the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "currencyGid":{
            "description":"The GID for currency.",
            "type":"string"
        },
        "netAmountDue":{
            "description":"The net amount that is due for the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "netDueDate":{
            "description":"The date on which the net amount for the invoice is due.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "paymentMethodCodeGid":{
            "description":"The method of payment that is expected for the invoice. Examples include: check, cash on deliver, credit card and electronic funds transfer.",
            "type":"string"
        },
        "startDate":{
            "description":"The start range for which this invoice was generated.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endDate":{
            "description":"The end range for which this invoice was generated.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "invoiceServiceCodeGid":{
            "description":"The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The terms of sale for this particular invoice.",
            "type":"string"
        },
        "discountAmount":{
            "description":"The total dollar amount of any discounts applied to the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "discountPercentage":{
            "description":"Either a specific amount for the discount or a percentage to be used for the discount.",
            "type":"number",
            "format":"double"
        },
        "discountDaysDue":{
            "description":"The number of days in the terms discount period by which payment is due if the terms of the discount are to be earned.",
            "type":"number",
            "format":"int32"
        },
        "discountDueDate":{
            "description":"The date that the payment must be made by in order for the discount to be earned.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "originStationCity":{
            "description":"The city in which the related shipment began.",
            "type":"string"
        },
        "originStationFsac":{
            "description":"The FSAC code for the station in which the related shipment began.",
            "type":"string"
        },
        "originStationSplc":{
            "description":"The SPLC code for the station in which the related shipment began.",
            "type":"string"
        },
        "originStationProvinceCode":{
            "description":"The province code in which the related shipment began.",
            "type":"string"
        },
        "originStationPostalCode":{
            "description":"The postal code in which the related shipment began.",
            "type":"string"
        },
        "originCountryCode3Gid":{
            "description":"The origin country code GID.",
            "type":"string"
        },
        "destStationCity":{
            "description":"The city in which the related shipment ends.",
            "type":"string"
        },
        "destStationFsac":{
            "description":"The FSAC code for the station in which the related shipment ended.",
            "type":"string"
        },
        "destStationSplc":{
            "description":"The SPLC code for the destination of the shipment which relates to this invoice.",
            "type":"string"
        },
        "destStationProvinceCode":{
            "description":"The province code in which the related shipment ended.",
            "type":"string"
        },
        "destStationPostalCode":{
            "description":"The postal code in which the related shipment ended.",
            "type":"string"
        },
        "destCountryCode3Gid":{
            "description":"The destination country code GID.",
            "type":"string"
        },
        "letterOfCreditExpDate":{
            "description":"The date until which the letter of credit is in effect. After this date, the letter of credit expires.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "letterOfCreditIssueDate":{
            "description":"The date that the letter of credit was issued.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "letterOfCreditNumber":{
            "description":"The identification number of the letter of credit.",
            "type":"string"
        },
        "vesselCodeQualifier":{
            "description":"The qualifier for the vessel.",
            "type":"string"
        },
        "vesselCode":{
            "description":"The vessel that was used for the shipment that relates to the invoice.",
            "type":"string"
        },
        "vesselCountryCode3Gid":{
            "description":"The vessel country code GID.",
            "type":"string"
        },
        "vesselGid":{
            "description":"Vessel ID for the invoice.",
            "type":"string"
        },
        "vesOpServprovAliasQualGid":{
            "description":"The vessel operator service provider alias qualifier GID.",
            "type":"string"
        },
        "vesOpServprovAliasValue":{
            "description":"Service provider alias of the vessel operator.",
            "type":"string"
        },
        "voyageNumber":{
            "description":"The number of the voyage that relates to the shipment for which this invoice is being created.",
            "type":"string"
        },
        "parentInvoiceGid":{
            "description":"The parent invoice GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "dateReceived":{
            "description":"The date the invoice was received.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "supplyCountryCode3Gid":{
            "description":"The Supply Country Code ID represents the country that the goods are coming from.",
            "type":"string"
        },
        "servprovVatRegNoGid":{
            "description":"The service provider VAT Registration ID is the VAT tax ID for the service provider.",
            "type":"string"
        },
        "customerVatRegNoGid":{
            "description":"The Customer VAT Registration ID is the VAT tax ID for the customer. ",
            "type":"string"
        },
        "vatExemptValue":{
            "description":"The VAT Exempt field is used when the bill is exempt from the tax. When it is checked, you need to specify whether the bill is Exempt with Credit or Exempt without Credit.",
            "type":"string"
        },
        "netAmtDueWithTax":{
            "description":"The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isPassThrough":{
            "description":"The Pass Through check box allows to the invoice to be approved for payment without being matched to a shipment.",
            "type":"boolean"
        },
        "consolidationType":{
            "description":"The value is set based on the invoice type involved - there are three consolidation types- STANDARD for a stand-alone invoice, PARENT for a parent invoice (for example, a consolidation invoice), or CHILD for a child invoice.",
            "type":"string"
        },
        "isFixedCost":{
            "description":"The Fixed Cost check box allows you to override the amount due calculation. When checked the amount due that you enter will be used regardless of the base and other charges.",
            "type":"boolean"
        },
        "baseCharge":{
            "description":"The Base Charge is the sum of the shipping charges for the invoice. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "otherCharge":{
            "description":"The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isCreditNote":{
            "description":"Indicates if this invoice is a credit note",
            "type":"boolean"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the service provider. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "sailDate":{
            "description":"The sail date is the date the vessel sails.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sailCutoffDate":{
            "description":"The sail cutoff date is the latest date in which you can get your cargo onto the vessel.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "railDate":{
            "description":"The rail date is the date when a container gets put on rail car.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isHazardous":{
            "description":"Indicator for identifying whether the invoiced shipment was or was not identified as carrying hazardous or dangerous goods. ",
            "type":"boolean"
        },
        "isTemperatureControl":{
            "description":"Indicator for identifying whether the invoiced shipment was or was not identified as requiring temperature control. ",
            "type":"boolean"
        },
        "invoicingProcess":{
            "description":"N/A",
            "type":"string"
        },
        "isVatAnalysisFixed":{
            "description":"Indicates if the VAT Analysis is fixed (user entered) and the system should not try to calculate it.",
            "type":"boolean"
        },
        "originalInvoiceGid":{
            "description":"For supplemental bills. This references the original bill. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "originalInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originalInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "glDate":{
            "description":"GL Date for the invoice as set by agent or manual action.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "invoiceRuleGid":{
            "description":"The rule ID used for generating this invoice/bill.",
            "type":"string"
        },
        "invConsConstraintSetGid":{
            "description":"Constraint Set ID is used for creating a consolidated invoice/bill. This will be used for identifying the parent invoice/bill when you add more invoices/bills with the same constraint set.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "orderReleases":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.orderReleases"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "protectiveServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.protectiveServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "stops":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.stops"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "ports":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.ports"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "lineItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.lineItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vatAnalyses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.vatAnalyses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.equipmentDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "routes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.routes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.shipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "supplyProvinceVatRegs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.supplyProvinceVatRegs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "notes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.notes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "summaries":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.summaries"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "summaryDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.summaryDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "allocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.allocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.allocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : baseCharge

The Base Charge is the sum of the shipping charges for the invoice.

Match All

The Base Charge is the sum of the shipping charges for the invoice.

Show Source

• object currencyType

{
    "description":"The Base Charge is the sum of the shipping charges for the invoice. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : dateReceived

The date the invoice was received.

Match All

The date the invoice was received.

Show Source

• object dateTimeType

{
    "description":"The date the invoice was received.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : discountAmount

The total dollar amount of any discounts applied to the invoice.

Match All

The total dollar amount of any discounts applied to the invoice.

Show Source

• object currencyType

{
    "description":"The total dollar amount of any discounts applied to the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : discountDueDate

The date that the payment must be made by in order for the discount to be earned.

Match All

The date that the payment must be made by in order for the discount to be earned.

Show Source

• object dateType

{
    "description":"The date that the payment must be made by in order for the discount to be earned.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : endDate

The end range for which this invoice was generated.

Match All

The end range for which this invoice was generated.

Show Source

• object dateTimeType

{
    "description":"The end range for which this invoice was generated.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.equipmentDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : glDate

GL Date for the invoice as set by agent or manual action.

Match All

GL Date for the invoice as set by agent or manual action.

Show Source

• object dateType

{
    "description":"GL Date for the invoice as set by agent or manual action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : invoiceDate

The date of the invoice.

Match All

The date of the invoice.

Show Source

• object dateTimeType

{
    "description":"The date of the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : letterOfCreditExpDate

The date until which the letter of credit is in effect. After this date, the letter of credit expires.

Match All

The date until which the letter of credit is in effect. After this date, the letter of credit expires.

Show Source

• object dateType

{
    "description":"The date until which the letter of credit is in effect. After this date, the letter of credit expires.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : letterOfCreditIssueDate

The date that the letter of credit was issued.

Match All

The date that the letter of credit was issued.

Show Source

• object dateType

{
    "description":"The date that the letter of credit was issued.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : lineItems

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.lineItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : netAmountDue

The net amount that is due for the invoice.

Match All

The net amount that is due for the invoice.

Show Source

• object currencyType

{
    "description":"The net amount that is due for the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : netAmtDueWithTax

The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).

Match All

The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).

Show Source

• object currencyType

{
    "description":"The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : netDueDate

The date on which the net amount for the invoice is due.

Match All

The date on which the net amount for the invoice is due.

Show Source

• object dateTimeType

{
    "description":"The date on which the net amount for the invoice is due.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : notes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.notes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderReleases

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.orderReleases"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : originalInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property originalInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property originalInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originalInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : otherCharge

The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.

Match All

The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.

Show Source

• object currencyType

{
    "description":"The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : parentInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : ports

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.ports"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : protectiveServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.protectiveServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : railDate

The rail date is the date when a container gets put on rail car.

Match All

The rail date is the date when a container gets put on rail car.

Show Source

• object dateTimeType

{
    "description":"The rail date is the date when a container gets put on rail car.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : routes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.routes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sailCutoffDate

The sail cutoff date is the latest date in which you can get your cargo onto the vessel.

Match All

The sail cutoff date is the latest date in which you can get your cargo onto the vessel.

Show Source

• object dateTimeType

{
    "description":"The sail cutoff date is the latest date in which you can get your cargo onto the vessel.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sailDate

The sail date is the date the vessel sails.

Match All

The sail date is the date the vessel sails.

Show Source

• object dateTimeType

{
    "description":"The sail date is the date the vessel sails.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : shipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.shipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : startDate

The start range for which this invoice was generated.

Match All

The start range for which this invoice was generated.

Show Source

• object dateTimeType

{
    "description":"The start range for which this invoice was generated.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stops

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.stops"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : summaries

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.summaries"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : summaryDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.summaryDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : supplyProvinceVatRegs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.supplyProvinceVatRegs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : vatAnalyses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.vatAnalyses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.allocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.allocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.allocations

Type: object

Show Source

• allocatedCost: allocatedCost
  No description.
• allocSeqNo: number (int64)
  No description.
• allocTypeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• links: array links
  Read Only: true
• orderAllocations: orderAllocations
• orderBaseLineAllocations: orderBaseLineAllocations
• orderLineAllocations: orderLineAllocations
• parentInvoice: parentInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentInvoiceGid: string
  If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipGroup: shipGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipGroupGid: string
  Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
  group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• timestamp: timestamp
  No description.
• voucher: voucher
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voucherGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"If populated, the INVOICE_GID indicates that this alllocation is for a child invoice.  This column indicates the parent invoice of the entire consolidation that was allocated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "voucherGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voucher":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/vouchers"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "orderAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.allocations.orderAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderLineAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.allocations.orderLineAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderBaseLineAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.allocations.orderBaseLineAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.allocations.orderAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderBaseLineAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.allocations.orderBaseLineAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderLineAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.allocations.orderLineAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : parentInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : shipGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : timestamp

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : voucher

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object vouchers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/vouchers"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.allocations.orderAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.allocations.orderAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.allocations.orderAllocations

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release record.
• invoiceGid: string
  Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill
• lineitemSeqNo: number (int32)
  Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill
• links: array links
  Read Only: true
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based on shipment
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release record.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "lineitemSeqNo":{
            "description":"Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill",
            "type":"number",
            "format":"int32"
        },
        "invoiceGid":{
            "description":"Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill",
            "type":"string"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based on  shipment ",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorials: accessorials
• accruals: accruals
• allocationGroupGid: string
  The allocation group that was calculated if the order travels from the plan from to the plan to as a single group order.
• allocations: allocations
• assignedItinerary: assignedItinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property assignedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• assignedItineraryGid: string
  Read Only: true

  The buy side itinerary that was selected when planning the order release.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• assignedSellItinerary: assignedSellItinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property assignedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• assignedSellItineraryGid: string
  Read Only: true

  The sell side itinerary that was selected when planning the order release.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  The attribute currency of the shipment.
• attributeCurrency2: attributeCurrency2
  The attribute currency of the shipment.
• attributeCurrency3: attributeCurrency3
  The attribute currency of the shipment.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• bestDirectCostBuy: bestDirectCostBuy
  Read Only: true

  The buy side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.
• bestDirectCostSell: bestDirectCostSell
  Read Only: true

  The sell side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.
• bestDirectRateofferGidBuy: string
  Read Only: true

  The buy side rate offering used to calculate the best buy direct cost.
• bestDirectRateofferGidSell: string
  Read Only: true

  The buy side rate offering used to calculate the best buy direct cost.
• bufferType: string
  Read Only: true

  Defines the buffer type if this order release is a buffer order that utilizes the buffer locations as points where the order will accumulate prior to moving on.
• bulkPlanGid: string
  Read Only: true

  If the order was planned onto a buy shipment via the bulk plan process, then the global identifier for the bulk plan.
• bundlingType: string
  AUTOMATIC or MANUAL ONLY allow bundling; they are distinguished only by user defined queries. DO NOT BUNDLE means order will never be bundled with other orders.
• buyGeneralLedgerGid: string
  The buy general ledger GID to be used for the order release costs.
• buyItineraryProfileGid: string
  The buy itinerary profile GID to be used as a constraint while planning the order release onto shipments.
• commercialPaymentCodeGid: string
  The commercial payment terms for the goods on the order release.
• consolidationTypeGid: string
  The type of consol (charter, vessel) to be used when assigning this order to the consol.
• customerUnitizationRequest: boolean
  The customer's request for unitization location.
• defaultStowageMode: string
  The default stowage mode to use for this order when loading onto stowage consol shipments.
• deliveryIsAppt: boolean
  A Y/N indicator for whether the early/late delivery times are appointment times.
• deliveryRailCarrier: string
  The delivery rail carrier used as identification on the shipment execution.
• destinationLocation: destinationLocation
  The destination location.
• destLocationGid: string
  The destination location GID.
• destLocationOverrideGid: string
  The destination location override GID used to define a new destination location scheduling the order while still retaining the original destination location.
• destuffLocation: destuffLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destuffLocationGid: string
  The location for destuffing (unloading) the container after the ocean move.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dimRateFactorGid: string
  The dim factor GID to be used when calculating dimensional rates.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• dropoffRoutingSequenceGid: string
  The pickup location routing sequence that controls how the stops can be planned for pickup such as first, absolute first, last.
• dutyPaid: string
  Indicating if duty is to be paid for the order release.
• earliestEstPickupDate: earliestEstPickupDate
  Read Only: true

  The earliest estimated pickup that was calculated if the order travels from the plan from to the plan to as a single estimated order.
• earlyDeliveryDate: earlyDeliveryDate
  The early delivery date and time defined for the order release; can be null.
• earlyPickupDate: earlyPickupDate
  The early pickup date and time defined for the order release; can be null.
• earlySailDate: earlySailDate
  No description.
• emPhoneNumber: string
  The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  The buy equipment group GID to be used as a constraint while planning the order release onto shipments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentGroupProfileGid: string
  The buy equipment group profile GID to be used as a constraint while planning the order release onto shipments.
• equipments: equipments
• equipmentType: equipmentType
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentTypeGid: string
  The buy equipment type GID to be used as a constraint while planning the order release onto shipments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• externalSystemId: string
  The external system ID used for the source of the order release.
• externalVoyageCode: string
  Specifies the number of the voyage as assigned by the carrier.After the voyages are queried from an external voyage service and the user selects a particular voyage result,the voyage number selected for this result will be saved in this column.
  This will be used while planning the order for a shipment.
  
• finalIncoTerm: string
  The final INCO term associated with the order release.
• finalTextLocation: string
  The final text location for the INCO terms.
• fixedItinerary: fixedItinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• fixedItineraryGid: string
  The fixed buy side itinerary can be defined to force the order release to be schedule with a constrained itinerary.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• fixedSellItinerary: fixedSellItinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• fixedSellItineraryGid: string
  The fixed sell side itinerary can be defined to force the order release to be schedule with a constrained itinerary.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• importLicenseExpirationDate: importLicenseExpirationDate
  The date the import license will expire.
• importLicenseIssueDate: importLicenseIssueDate
  The import license issue date.
• importLicenseNumber: string
  The import license number.
• importLicenseReceiveDate: importLicenseReceiveDate
  The import license received date.
• importLicenseRequired: string
  A Y/N indicator for whether this order requires an import license.
• incoTermGid: string
  The INCO terms GID.
• insertDate: insertDate
  Read Only: true

  insert date
• inspectionDate: inspectionDate
  The inspection actual date associated with the inspection number.
• inspectionNumber: string
  An inspection number for the order release for informational purposes.
• inspectionRequired: string
  A Y/N indicator for whether an inspection is required.
• inspectionScheduleDate: inspectionScheduleDate
  The inspection scheduled date associated with the inspection number.
• involvedParties: involvedParties
• isConsolidateOrEquipment: boolean
  Whether to consolidate order release equipment when bundling.
• isDirectVoyage: boolean
  
  The flag indicates whether only direct voyages, that is voyages without trans-shipments should be retrieved by an external voyage service.
  It will be used for querying the voyage based on data from order release.
  
• isIgnoreLocationCalendar: boolean
  A Y/N field indicating whether the location calendar should be ignored when planning shipments for the order. If NULL, treat it as N.
• isKnownShipper: boolean
  A Y/N indicator for whether the shipper involved party is a known shipper for air travel.
• isLocRequired: boolean
  A Y/N field indicating whether a letter of credit is required for the order release.
• isLocStale: boolean
  A Y/N field indicating whether the letter of credit is stale or expired.
• isPreEnteredPu: boolean
  A Y/N field indicating whether the order release is a pre-entered pickup for customs processing.
• isSplittable: boolean
  A Y/N field that indicates whether the order release can be split when planning during container optimization.
• isTemplate: boolean
  A Y/N indicator specifying this order release as a template if the value is Y.
• isTopoff: boolean
  This field indicates whether the order is a topoff order or not.
• lateDeliveryDate: lateDeliveryDate
  The late delivery date and time defined for the order release; can be null.
• latePickupDate: latePickupDate
  The latest pickup date and time defined for the order release; can be null.
• lateSailDate: lateSailDate
  No description.
• latestEstDeliveryDate: latestEstDeliveryDate
  Read Only: true

  The latest estimate delivery date calculated from the last leg shipments.
• latestEstPickupDate: latestEstPickupDate
  Read Only: true

  The latest estimated pickup date calculated from the first leg shipments.
• legConsolidationGroupGid: string
  The leg consolidation group set during planning.
• legConstraints: legConstraints
• lines: lines
• links: array links
  Read Only: true
• loadPoint: string
  The source load point for loading of the equipment if required.
• locAdvisingNumber: string
  The letter of credit advising number.
• locAmount: locAmount
  The letter of credit amount.
• locConfirmingNumber: string
  The letter of credit confirming number.
• locExpirationDate: locExpirationDate
  The letter of credit expiration date.
• locIssueDate: locIssueDate
  The letter of credit issue date.
• locLatestShippingDate: locLatestShippingDate
  The letter of credit latest shipping date.
• locNegotiatedDays: number (int32)
  The letter of credit negotiated days.
• locNumber: string
  The letter of credit number.
• locReceivedDate: locReceivedDate
  The letter of credit received date.
• maxHeight: number (double)
  The maximum height calculated from the order release lines.
• maxHeightBase: number (double)
  The maximum height in the base unit of measure.
• maxHeightUomCode: string
  The maximum height unit of measure.
• maxLength: number (double)
  The max length calculated from the order release lines.
• maxLengthBase: number (double)
  The max length in the base unit of measure.
• maxLengthUomCode: string
  The max length unit of measure.
• maxWidth: number (double)
  The maximum width calculated from the order release lines.
• maxWidthBase: number (double)
  The maximum width in the base unit of measure.
• maxWidthUomCode: string
  The maximum width unit of measure.
• modeProfileGid: string
  The buy mode profile GID to be used as a constraint while planning the order release onto shipments.
• movePerspectiveGid: string
  The mode perspective GID for the order release.
• mustShipDirect: boolean
  A Y/N indicator for whether this order release must ship direct.
• mustShipThruPool: boolean
  A Y/N indicator for whether this order release must ship through pool.
• mustShipThruXDock: boolean
  A Y/N indicator for whether this order release must ship through cross dock.
• onRtExecution: boolean
  A Y/N field indicating whether that a shipment built from this order release has been assigned to a route instance leg. For migration: old existing order releases migrated to the default value ('N').
• orderBase: orderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderBaseGid: string
  The GID for the order base associated with the order release if this order release was generated from an order base.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• orderReleaseGid: string
  The GID for the order release.
• orderReleaseName: string
  An open field for you to enter another identifier (name) for the order release.
• orderReleaseTypeGid: string
  A GID to define the type of the order release. For example: Customer order, Distribution order, Manufacturing order, Purchase order, etc.
• orderReleaseXid: string
  The XID for the order release.
• otmVersion: string
  Read Only: true

  The OTM version number used when order was created.
• partitionGid: string
  The partition GID used as according to this name, bulk plan partition orders to be planned together in one partition.
• paymentMethodCodeGid: string
  The payment method GID.
• pickupIsAppt: boolean
  A Y/N indicator for whether the early/late pickup times are appointment times
• pickupRailCarrier: string
  The pickup rail carrier used as identification on the shipment execution.
• pickupRoutingSequenceGid: string
  The pickup location routing sequence that controls how the stops can be planned for pickup such as first, absolute first, last.
• planFromLoadPoint: string
  The load point associated with plan from location.
• planFromLocation: planFromLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property planFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• planFromLocationGid: string
  The plan from location GID. This value can be a different location from the actual source location defined on the order release. The plan from location is where the system will start to plan the shipments for the order release.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• planFromLocOverrideGid: string
  The plan from location override GID used to define a new plan from location scheduling the order while still retaining the original plan from location.
• planningGroupGid: string
  The planning group GID to use when segmenting a large number of order releases into multiple smaller bulk planning runs.
• planToLocation: planToLocation
  The location from where the order is planned.
• planToLocationGid: string
  Must be Y or N. Y indicates that the order should not be bundled with any others. Order releasing logic will copy this value from the order base when the order is released.
• planToLocOverrideGid: string
  The plan to location override GID used to define a new plan to location scheduling the order while still retaining the original plan to location.
• planToUnloadPoint: string
  The unload point associated with plan to location.
• portOfDisLocation: portOfDisLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfDisLocationGid: string
  Location GID of the port of discharge for primary leg carrier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfDisLocOverrideGid: string
  Location override GID of the port of discharge for primary leg carrier.
• portOfLoadLocation: portOfLoadLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfLoadLocationGid: string
  Location GID of the port of load for the primary leg carrier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfLoadLocOverrideGid: string
  Location override GID of the port of load for the primary leg carrier.
• predictedOrderRoute: string
  Stores the predicted order route path.
• primaryLegDestLoc: primaryLegDestLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegDestLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• primaryLegDestLocGid: string
  Location GID of destination for primary leg shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• primaryLegSourceLoc: primaryLegSourceLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegSourceLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• primaryLegSourceLocGid: string
  Location GID of source for primary leg shipment
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• primLegDestOverrideLocGid: string
  Location override GID of destination for primary leg shipment.
• primLegSrcLocOverrideGid: string
  Location override GID of source for primary leg shipment
• priority: number (int32)
  The priority associated with an order release.
• quote: quote
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property quoteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• quoteGid: string
  The quote GID generated if this order release went through the quoting process.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• quoteOptionNumber: number (int64)
  The quote option number for the order release. Informational.
• railRouteCodeGid: string
  The buy itinerary profile GID to be used as a constraint while planning the order release onto shipments.
• rateGeoGid: string
  Read Only: true

  The buy rate detail GID to be used as a constraint while planning the order release onto shipments.
• rateOfferingGid: string
  Read Only: true

  The buy rate offering GID to be used as a constraint while planning the order release onto shipments.
• rateServiceGid: string
  The buy rate service GID to be used as a constraint while planning the order release onto shipments.
• rateServiceProfileGid: string
  The buy rate service profile GID to be used as a constraint while planning the order release onto shipments.
• refnums: refnums
• releaseMethodGid: string
  The release method GID is the order configuration rule and this drives the configuration of the order such as ship unit or line as well as various calculations.
• remarks: remarks
• routingConstraintGid: string
  The buy itinerary profile GID to be used as a constraint while planning the order release onto shipments.
• secondaryTVolume: secondaryTVolume
  The secondary total volume for the order that sums up the secondary weight values from the order release lines.
• secondaryTWeight: secondaryTWeight
  The secondary total weight for the order that sums up secondary weight values from the order release line.
• sellBulkPlanGid: string
  Read Only: true

  If the order was planned onto a sell shipment via the bulk plan process, then the global identifier for the bulk plan.
• sellGeneralLedgerGid: string
  The sell general ledger GID to be used for the order release revenue.
• sellItineraryProfileGid: string
  The sell itinerary profile GID to be used as a constraint while planning the order release onto shipments.
• sellRateGeoGid: string
  Read Only: true

  The sell rate detail GID to be used as a constraint while planning the order release onto shipments.
• sellRateOfferingGid: string
  Read Only: true

  The sell rate offering GID to be used as a constraint while planning the order release onto shipments.
• sellServprov: sellServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sellServprovGid: string
  The sell service provider GID to be used as a constraint while planning the order release onto shipments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sellServprovProfileGid: string
  The sell service provider GID to be used as a constraint while planning the order release onto shipments.
• services: services
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The buy service provider GID to be used as a constraint while planning the order release onto shipments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprovProfileGid: string
  The buy service provider profile GID to be used as a constraint while planning the order release onto shipments.
• shipUnitDiameter: shipUnitDiameter
  The diameter of the ship unit for cyclindrical objects. This column will show value only if the order release has one ship unit.
• shipUnitHeight: shipUnitHeight
  The height of the ship unit. This column will show value only if the order release has one ship unit.
• shipUnitLength: shipUnitLength
  The length of the ship unit. This column will show value only if the order release has one ship unit.
• shipUnitOrigin: string
  Indicates how the ship units were created (BL=order base by line, BS=order base by ship unit, RL=order release by line, RS=order release by ship unit). If this field is not 'RS' (formerly 'U'), the system deletes all existing order ship unit for the given order release, before calling new releasing logic to generate ship unit.
• shipUnits: shipUnits
• shipUnitWidth: shipUnitWidth
  The width of the ship unit. This will show a value only if the order release has one ship unit.
• shipWithGroup: string
  Ship with group tags orders that need to be placed on a shipment together.
• sourceLocation: sourceLocation
  The source location.
• sourceLocationGid: string
  The source location GID.
• specialServices: specialServices
• srcLocationOverrideGid: string
  The source location override GID used to define a new source location scheduling the order while still retaining the original source location.
• statuses: statuses
• stops: stops
• stuffLocation: stuffLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• stuffLocationGid: string
  The location for stuffing (loading) the container prior to shipping.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• surveyLayCanDate: surveyLayCanDate
  The survey lay can date for the order release.
• templateType: string
  Hide template created for customer from other order UI. "Customer" is for customer template.
• termLocationText: string
  Location text that can be entered.
• texts: texts
• timeWindowEmphasisGid: string
  The time window emphasis to be used when calculating the best start times for shipment, it can emphasize the pickup or delivery windows.
• totalDeclaredValue: totalDeclaredValue
  The total declared value calculated from the order release lines.
• totalItemPackageCount: number (int32)
  Read Only: true

  The total item package count calculated from the order release lines.
• totalNetVolume: totalNetVolume
  The total net volume calculated from the order release lines.
• totalNetWeight: totalNetWeight
  The total net weight calculated from the order release lines.
• totalPackagingUnitCount: number (int32)
  Read Only: true

  The total packaging unit count calculated from the order release lines
• totalShipUnitCount: number (int32)
  Read Only: true

  The total number of ship units calculated from the order release ship units.
• totalVolume: totalVolume
  Read Only: true

  The total volume calculated from the order release lines.
• totalWeight: totalWeight
  Read Only: true

  The total weight calculated from the order release lines.
• trackingEvents: trackingEvents
• transportHandlingUnitGid: string
  The transport handling unit associated with the ship unit dimension values. This columns will show value only if the order release has one ship unit.
• transportModeGid: string
  The buy transport mode GID to be used as a constraint while planning the order release onto shipments.
• ultDestCountryCode3Gid: string
  The ultimate destination country code for this order release. It may be beyond the plan to or destination location defined on the order release.
• unitizationConditionName: string
  The unitization (loading of equipment) condition name value.
• unloadPoint: string
  The destination unload point for the unloading of the equipment if required.
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.
• userDefined2IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.
• userDefined3IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.
• userDefined4IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.
• userDefined5IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.
• voyage: voyage
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voyageGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "orderReleaseGid":{
            "description":"The GID for the order release.",
            "type":"string"
        },
        "orderReleaseXid":{
            "description":"The XID for the order release.",
            "type":"string"
        },
        "orderReleaseName":{
            "description":"An open field for you to enter another identifier (name) for the order release.",
            "type":"string"
        },
        "orderReleaseTypeGid":{
            "description":"A GID to define the type of the order release. For example: Customer order, Distribution order, Manufacturing order, Purchase order, etc.",
            "type":"string"
        },
        "isTemplate":{
            "description":"A Y/N indicator specifying this order release as a template if the value is Y.",
            "type":"boolean"
        },
        "orderBaseGid":{
            "description":"The GID for the order base associated with the order release if this order release was generated from an order base. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "sourceLocationGid":{
            "description":"The source location GID.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The destination location GID.",
            "type":"string"
        },
        "earlyPickupDate":{
            "description":"The early pickup date and time defined for the order release; can be null.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latePickupDate":{
            "description":"The latest pickup date and time defined for the order release; can be null.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "earlyDeliveryDate":{
            "description":"The early delivery date and time defined for the order release; can be null.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lateDeliveryDate":{
            "description":"The late delivery date and time defined for the order release; can be null.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "fixedItineraryGid":{
            "description":"The fixed buy side itinerary can be defined to force the order release to be schedule with a constrained itinerary. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "fixedItinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "assignedItineraryGid":{
            "description":"The buy side itinerary that was selected when planning the order release. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "assignedItinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property assignedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "fixedSellItineraryGid":{
            "description":"The fixed sell side itinerary can be defined to force the order release to be schedule with a constrained itinerary. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "fixedSellItinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "shipUnitOrigin":{
            "description":"Indicates how the ship units were created (BL=order base by line, BS=order base by ship unit, RL=order release by line, RS=order release by ship unit).  If this field is not 'RS' (formerly 'U'), the system deletes all existing order ship unit for the given order release, before calling new releasing logic to generate ship unit.",
            "type":"string"
        },
        "totalWeight":{
            "description":"The total weight calculated from the order release lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "totalVolume":{
            "description":"The total volume calculated from the order release lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "totalPackagingUnitCount":{
            "description":"The total packaging unit count calculated from the order release lines",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "totalItemPackageCount":{
            "description":"The total item package count calculated from the order release lines.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "maxLength":{
            "description":"The max length calculated from the order release lines.",
            "type":"number",
            "format":"double"
        },
        "maxLengthUomCode":{
            "description":"The max length unit of measure.",
            "type":"string"
        },
        "maxLengthBase":{
            "description":"The max length in the base unit of measure.",
            "type":"number",
            "format":"double"
        },
        "maxWidth":{
            "description":"The maximum width calculated from the order release lines.",
            "type":"number",
            "format":"double"
        },
        "maxWidthUomCode":{
            "description":"The maximum width unit of measure.",
            "type":"string"
        },
        "maxWidthBase":{
            "description":"The maximum width in the base unit of measure.",
            "type":"number",
            "format":"double"
        },
        "maxHeight":{
            "description":"The maximum height calculated from the order release lines.",
            "type":"number",
            "format":"double"
        },
        "maxHeightUomCode":{
            "description":"The maximum height unit of measure.",
            "type":"string"
        },
        "maxHeightBase":{
            "description":"The maximum height in the base unit of measure.",
            "type":"number",
            "format":"double"
        },
        "planFromLocationGid":{
            "description":"The plan from location GID. This value can be a different location from the actual source location defined on the order release. The plan from location is where the system will start to plan the shipments for the order release. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "planFromLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property planFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "planToLocationGid":{
            "description":"Must be Y or N. Y indicates that the order should not be bundled with any others. Order releasing logic will copy this value from the order base when the order is released.",
            "type":"string"
        },
        "assignedSellItineraryGid":{
            "description":"The sell side itinerary that was selected when planning the order release. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "assignedSellItinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property assignedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "bulkPlanGid":{
            "description":"If the order was planned onto a buy shipment via the bulk plan process, then the global identifier for the bulk plan.",
            "type":"string",
            "readOnly":true
        },
        "bestDirectCostBuy":{
            "description":"The buy side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ],
            "readOnly":true
        },
        "bestDirectCostSell":{
            "description":"The sell side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ],
            "readOnly":true
        },
        "bestDirectRateofferGidBuy":{
            "description":"The buy side rate offering used to calculate the best buy direct cost.",
            "type":"string",
            "readOnly":true
        },
        "bestDirectRateofferGidSell":{
            "description":"The buy side rate offering used to calculate the best buy direct cost.",
            "type":"string",
            "readOnly":true
        },
        "buyGeneralLedgerGid":{
            "description":"The buy general ledger GID to be used for the order release costs.",
            "type":"string"
        },
        "sellGeneralLedgerGid":{
            "description":"The sell general ledger GID to be used for the order release revenue.",
            "type":"string"
        },
        "totalNetWeight":{
            "description":"The total net weight calculated from the order release lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalNetVolume":{
            "description":"The total net volume calculated from the order release lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "sellBulkPlanGid":{
            "description":"If the order was planned onto a sell shipment via the bulk plan process, then the global identifier for the bulk plan.",
            "type":"string",
            "readOnly":true
        },
        "totalShipUnitCount":{
            "description":"The total number of ship units calculated from the order release ship units.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "loadPoint":{
            "description":"The source load point for loading of the equipment if required.",
            "type":"string"
        },
        "unloadPoint":{
            "description":"The destination unload point for the unloading of the equipment if required.",
            "type":"string"
        },
        "pickupIsAppt":{
            "description":"A Y/N indicator for whether the early/late pickup times are appointment times",
            "type":"boolean"
        },
        "deliveryIsAppt":{
            "description":"A Y/N indicator for whether the early/late delivery times are appointment times.",
            "type":"boolean"
        },
        "planFromLoadPoint":{
            "description":"The load point associated with plan from location.",
            "type":"string"
        },
        "planToUnloadPoint":{
            "description":"The unload point associated with plan to location.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the order release.",
            "type":"string"
        },
        "externalSystemId":{
            "description":"The external system ID used for the source of the order release.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method GID. ",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The INCO terms GID.",
            "type":"string"
        },
        "termLocationText":{
            "description":"Location text that can be entered.",
            "type":"string"
        },
        "planningGroupGid":{
            "description":"The planning group GID to use when segmenting a large number of order releases into multiple smaller bulk planning runs.",
            "type":"string"
        },
        "timeWindowEmphasisGid":{
            "description":"The time window emphasis to be used when calculating the best start times for shipment, it can emphasize the pickup or delivery windows.",
            "type":"string"
        },
        "isKnownShipper":{
            "description":"A Y/N indicator for whether the shipper involved party is a known shipper for air travel.",
            "type":"boolean"
        },
        "dimRateFactorGid":{
            "description":"The dim factor GID to be used when calculating dimensional rates.",
            "type":"string"
        },
        "releaseMethodGid":{
            "description":"The release method GID is the order configuration rule and this drives the configuration of the order such as ship unit or line as well as various calculations.",
            "type":"string"
        },
        "finalIncoTerm":{
            "description":"The final INCO term associated with the order release.",
            "type":"string"
        },
        "finalTextLocation":{
            "description":"The final text location for the INCO terms.",
            "type":"string"
        },
        "inspectionNumber":{
            "description":"An inspection number for the order release for informational purposes.",
            "type":"string"
        },
        "inspectionScheduleDate":{
            "description":"The inspection scheduled date associated with the inspection number.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "inspectionDate":{
            "description":"The inspection actual date associated with the inspection number.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "surveyLayCanDate":{
            "description":"The  survey lay can date for the order release.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "locNumber":{
            "description":"The letter of credit number.",
            "type":"string"
        },
        "locIssueDate":{
            "description":"The letter of credit issue date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "locReceivedDate":{
            "description":"The letter of credit received date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "locLatestShippingDate":{
            "description":"The letter of credit latest shipping date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "locNegotiatedDays":{
            "description":"The letter of credit negotiated days.",
            "type":"number",
            "format":"int32"
        },
        "locAmount":{
            "description":"The letter of credit amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "locAdvisingNumber":{
            "description":"The letter of credit advising number.",
            "type":"string"
        },
        "locConfirmingNumber":{
            "description":"The letter of credit confirming number.",
            "type":"string"
        },
        "srcLocationOverrideGid":{
            "description":"The source location override GID used to define a new source location scheduling the order while still retaining the original source location.",
            "type":"string"
        },
        "destLocationOverrideGid":{
            "description":"The destination location override GID used to define a new destination location scheduling the order while still retaining the original destination location.",
            "type":"string"
        },
        "planFromLocOverrideGid":{
            "description":"The plan from location override GID used to define a new plan from location scheduling the order while still retaining the original plan from location.",
            "type":"string"
        },
        "planToLocOverrideGid":{
            "description":"The plan to location override GID used to define a new plan to location scheduling the order while still retaining the original plan to location.",
            "type":"string"
        },
        "secondaryTWeight":{
            "description":"The secondary total weight for the order that sums up  secondary weight values from the order release line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondaryTVolume":{
            "description":"The secondary total volume for the order that sums up the secondary weight values from the order release lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "rateServiceProfileGid":{
            "description":"The buy rate service profile GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The buy service provider GID to be used as a constraint while planning the order release onto shipments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "servprovProfileGid":{
            "description":"The buy service provider profile GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The buy transport mode GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The buy mode profile GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"The buy equipment group GID to be used as a constraint while planning the order release onto shipments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "equipmentGroupProfileGid":{
            "description":"The buy equipment group profile GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"The buy rate offering GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string",
            "readOnly":true
        },
        "rateGeoGid":{
            "description":"The buy rate detail GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string",
            "readOnly":true
        },
        "sellRateOfferingGid":{
            "description":"The sell rate offering GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string",
            "readOnly":true
        },
        "sellRateGeoGid":{
            "description":"The sell rate detail GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string",
            "readOnly":true
        },
        "mustShipDirect":{
            "description":"A Y/N indicator for whether this order release must ship direct.",
            "type":"boolean"
        },
        "mustShipThruXDock":{
            "description":"A Y/N indicator for whether this order release must ship through cross dock.",
            "type":"boolean"
        },
        "mustShipThruPool":{
            "description":"A Y/N indicator for whether this order release must ship through pool.",
            "type":"boolean"
        },
        "shipWithGroup":{
            "description":"Ship with group tags orders that need to be placed on a shipment together.",
            "type":"string"
        },
        "primaryLegSourceLocGid":{
            "description":"Location GID of source for primary leg shipment <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "primaryLegSourceLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegSourceLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "primLegSrcLocOverrideGid":{
            "description":"Location override GID of source for primary leg shipment",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"Location GID of the port of load for the primary leg carrier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfLoadLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfLoadLocOverrideGid":{
            "description":"Location override GID of the port of load for the primary leg carrier.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"Location GID of the port of discharge for primary leg carrier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfDisLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfDisLocOverrideGid":{
            "description":"Location override GID of the port of discharge for primary leg carrier.",
            "type":"string"
        },
        "primaryLegDestLocGid":{
            "description":"Location GID of destination for primary leg shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "primaryLegDestLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegDestLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "primLegDestOverrideLocGid":{
            "description":"Location override GID of destination for primary leg shipment.",
            "type":"string"
        },
        "importLicenseRequired":{
            "description":"A Y/N indicator for whether this order requires an import license.",
            "type":"string"
        },
        "importLicenseIssueDate":{
            "description":"The import license issue date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "importLicenseReceiveDate":{
            "description":"The import license received date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "importLicenseExpirationDate":{
            "description":"The date the import license will expire.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "importLicenseNumber":{
            "description":"The import license number.",
            "type":"string"
        },
        "locExpirationDate":{
            "description":"The letter of credit expiration date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "isLocRequired":{
            "description":"A Y/N field indicating whether a letter of credit is required for the order release.",
            "type":"boolean"
        },
        "inspectionRequired":{
            "description":"A Y/N indicator for whether an inspection is required.",
            "type":"string"
        },
        "unitizationConditionName":{
            "description":"The unitization (loading of equipment) condition name value.",
            "type":"string"
        },
        "stuffLocationGid":{
            "description":"The location for stuffing (loading) the container prior to shipping. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "stuffLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destuffLocationGid":{
            "description":"The location for destuffing (unloading) the container after the ocean move. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destuffLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "customerUnitizationRequest":{
            "description":"The customer's request for unitization location.",
            "type":"boolean"
        },
        "defaultStowageMode":{
            "description":"The default stowage mode to use for this order when loading onto stowage consol shipments.",
            "type":"string"
        },
        "consolidationTypeGid":{
            "description":"The type of consol (charter, vessel) to be used when assigning this order to the consol.",
            "type":"string"
        },
        "movePerspectiveGid":{
            "description":"The mode perspective GID for the order release.",
            "type":"string"
        },
        "quoteGid":{
            "description":"The quote GID generated if this order release went through the quoting process. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "quote":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property quoteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/quotes"
                }
            ],
            "readOnly":true
        },
        "commercialPaymentCodeGid":{
            "description":"The commercial payment terms for the goods on the order release.",
            "type":"string"
        },
        "isLocStale":{
            "description":"A Y/N field indicating whether the letter of credit is stale or expired.",
            "type":"boolean"
        },
        "ultDestCountryCode3Gid":{
            "description":"The ultimate destination country code for this order release. It may be beyond the plan to or destination location defined on the order release.",
            "type":"string"
        },
        "templateType":{
            "description":"Hide template created for customer from other order UI. \"Customer\" is for customer template.",
            "type":"string"
        },
        "bundlingType":{
            "description":"AUTOMATIC or MANUAL ONLY allow bundling; they are distinguished only by user defined queries. DO NOT BUNDLE means order will never be bundled with other orders.",
            "type":"string"
        },
        "isConsolidateOrEquipment":{
            "description":"Whether to consolidate order release equipment when bundling.",
            "type":"boolean"
        },
        "dutyPaid":{
            "description":"Indicating if duty is to be paid for the order release.",
            "type":"string"
        },
        "quoteOptionNumber":{
            "description":"The quote option number for the order release. Informational.",
            "type":"number",
            "format":"int64"
        },
        "partitionGid":{
            "description":"The partition GID used as according to this name, bulk plan partition orders to be planned together in one partition.",
            "type":"string"
        },
        "totalDeclaredValue":{
            "description":"The total declared value calculated from the order release lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "buyItineraryProfileGid":{
            "description":"The buy itinerary profile GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "sellItineraryProfileGid":{
            "description":"The sell itinerary profile GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "bufferType":{
            "description":"Defines the buffer type if this order release is a buffer order that utilizes the buffer locations as points where the order will accumulate prior to moving on.",
            "type":"string",
            "readOnly":true
        },
        "sellServprovGid":{
            "description":"The sell service provider GID to be used as a constraint while planning the order release onto shipments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sellServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "sellServprovProfileGid":{
            "description":"The sell service provider GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "isIgnoreLocationCalendar":{
            "description":"A Y/N field indicating whether the location calendar should be ignored when planning shipments for the order. If NULL, treat it as N.",
            "type":"boolean"
        },
        "rateServiceGid":{
            "description":"The buy rate service GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "shipUnitWidth":{
            "description":"The width of the ship unit. This will show a value only if the order release has one ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "shipUnitLength":{
            "description":"The length of the ship unit. This column will show value only if the order release has one ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "shipUnitHeight":{
            "description":"The height of the ship unit. This column will show value only if the order release has one ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "shipUnitDiameter":{
            "description":"The diameter of the ship unit for cyclindrical objects. This column will show value only if the order release has one ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit associated with the ship unit dimension values. This columns will show value only if the order release has one ship unit.",
            "type":"string"
        },
        "onRtExecution":{
            "description":"A Y/N field indicating whether that a shipment built from this order release has been assigned to a route instance leg. For migration: old existing order releases migrated to the default value ('N').",
            "type":"boolean"
        },
        "isSplittable":{
            "description":"A Y/N field that indicates whether the order release can be split when planning during container optimization.",
            "type":"boolean"
        },
        "pickupRoutingSequenceGid":{
            "description":"The pickup location routing sequence that controls how the stops can be planned for pickup such as first, absolute first, last.",
            "type":"string"
        },
        "dropoffRoutingSequenceGid":{
            "description":"The pickup location routing sequence that controls how the stops can be planned for pickup such as first, absolute first, last.",
            "type":"string"
        },
        "latestEstDeliveryDate":{
            "description":"The latest estimate delivery date calculated from the last leg shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "otmVersion":{
            "description":"The OTM version number used when order was created.",
            "type":"string",
            "readOnly":true
        },
        "priority":{
            "description":"The priority associated with an order release.",
            "type":"number",
            "format":"int32"
        },
        "latestEstPickupDate":{
            "description":"The latest estimated pickup date calculated from the first leg shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "pickupRailCarrier":{
            "description":"The pickup rail carrier used as identification on the shipment execution.",
            "type":"string"
        },
        "deliveryRailCarrier":{
            "description":"The delivery rail carrier used as identification on the shipment execution.",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"The buy equipment type GID to be used as a constraint while planning the order release onto shipments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentType":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentTypes"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "railRouteCodeGid":{
            "description":"The buy itinerary profile GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "emPhoneNumber":{
            "description":"The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.",
            "type":"string"
        },
        "legConsolidationGroupGid":{
            "description":"The leg consolidation group set during planning.",
            "type":"string"
        },
        "isPreEnteredPu":{
            "description":"A Y/N field indicating whether the order release is a pre-entered pickup for customs processing.",
            "type":"boolean"
        },
        "routingConstraintGid":{
            "description":"The buy itinerary profile GID to be used as a constraint while planning the order release onto shipments.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "allocationGroupGid":{
            "description":"The allocation group that was calculated if the order travels from the plan from to the plan to as a single group order.",
            "type":"string"
        },
        "earliestEstPickupDate":{
            "description":"The earliest estimated pickup that was calculated if the order travels from the plan from to the plan to as a single estimated order.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "isTopoff":{
            "description":"This field indicates whether the order is a topoff order or not.",
            "type":"boolean"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "earlySailDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lateSailDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "voyageGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voyage":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/voyages"
                }
            ],
            "readOnly":true
        },
        "externalVoyageCode":{
            "description":"Specifies the number of the voyage as assigned by the carrier.After the voyages are queried from an external voyage service and the user selects a particular voyage result,the voyage number selected for this result will be saved in this column.<br>            This will be used while planning the order for a shipment.<br>            ",
            "type":"string"
        },
        "isDirectVoyage":{
            "description":"<br>            The flag indicates whether only direct voyages, that is voyages without trans-shipments should be retrieved by an external voyage service.<br>            It will be used for querying the voyage based on data from order release.   <br>            ",
            "type":"boolean"
        },
        "predictedOrderRoute":{
            "description":"Stores the predicted order route path.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "services":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.services"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.equipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "lines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accruals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.accruals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "legConstraints":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.legConstraints"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "stops":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.stops"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "trackingEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.trackingEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "allocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.allocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "destinationLocation":{
            "description":"The destination location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ]
        },
        "sourceLocation":{
            "description":"The source location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ]
        },
        "planToLocation":{
            "description":"The location from where the order is planned.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accruals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.accruals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.allocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : assignedItinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property assignedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property assignedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property assignedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : assignedSellItinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property assignedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property assignedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property assignedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : attributeCurrency1

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : bestDirectCostBuy

Read Only: true

The buy side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.

Match All

The buy side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.

Show Source

• object currencyType

{
    "description":"The buy side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ],
    "readOnly":true
}

Nested Schema : bestDirectCostSell

Read Only: true

The sell side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.

Match All

The sell side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.

Show Source

• object currencyType

{
    "description":"The sell side best direct cost that was calculated if the order travels from the plan from to the plan to as a single direct order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ],
    "readOnly":true
}

Nested Schema : destinationLocation

The destination location.

Match All

The destination location.

Show Source

• object locations

{
    "description":"The destination location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ]
}

Nested Schema : destuffLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : earliestEstPickupDate

Read Only: true

The earliest estimated pickup that was calculated if the order travels from the plan from to the plan to as a single estimated order.

Match All

The earliest estimated pickup that was calculated if the order travels from the plan from to the plan to as a single estimated order.

Show Source

• object dateTimeType

{
    "description":"The earliest estimated pickup that was calculated if the order travels from the plan from to the plan to as a single estimated order.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : earlyDeliveryDate

The early delivery date and time defined for the order release; can be null.

Match All

The early delivery date and time defined for the order release; can be null.

Show Source

• object dateTimeType

{
    "description":"The early delivery date and time defined for the order release; can be null.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : earlyPickupDate

The early pickup date and time defined for the order release; can be null.

Match All

The early pickup date and time defined for the order release; can be null.

Show Source

• object dateTimeType

{
    "description":"The early pickup date and time defined for the order release; can be null.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : earlySailDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : equipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.equipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentType

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object equipmentTypes

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentTypes"
        }
    ],
    "readOnly":true
}

Nested Schema : fixedItinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fixedItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : fixedSellItinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property fixedSellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : importLicenseExpirationDate

The date the import license will expire.

Match All

The date the import license will expire.

Show Source

• object dateType

{
    "description":"The date the import license will expire.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : importLicenseIssueDate

The import license issue date.

Match All

The import license issue date.

Show Source

• object dateType

{
    "description":"The import license issue date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : importLicenseReceiveDate

The import license received date.

Match All

The import license received date.

Show Source

• object dateType

{
    "description":"The import license received date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : inspectionDate

The inspection actual date associated with the inspection number.

Match All

The inspection actual date associated with the inspection number.

Show Source

• object dateType

{
    "description":"The inspection actual date associated with the inspection number.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : inspectionScheduleDate

The inspection scheduled date associated with the inspection number.

Match All

The inspection scheduled date associated with the inspection number.

Show Source

• object dateType

{
    "description":"The inspection scheduled date associated with the inspection number.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lateDeliveryDate

The late delivery date and time defined for the order release; can be null.

Match All

The late delivery date and time defined for the order release; can be null.

Show Source

• object dateTimeType

{
    "description":"The late delivery date and time defined for the order release; can be null.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : latePickupDate

The latest pickup date and time defined for the order release; can be null.

Match All

The latest pickup date and time defined for the order release; can be null.

Show Source

• object dateTimeType

{
    "description":"The latest pickup date and time defined for the order release; can be null.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lateSailDate

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : latestEstDeliveryDate

Read Only: true

The latest estimate delivery date calculated from the last leg shipments.

Match All

The latest estimate delivery date calculated from the last leg shipments.

Show Source

• object dateTimeType

{
    "description":"The latest estimate delivery date calculated from the last leg shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : latestEstPickupDate

Read Only: true

The latest estimated pickup date calculated from the first leg shipments.

Match All

The latest estimated pickup date calculated from the first leg shipments.

Show Source

• object dateTimeType

{
    "description":"The latest estimated pickup date calculated from the first leg shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : legConstraints

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.legConstraints"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locAmount

The letter of credit amount.

Match All

The letter of credit amount.

Show Source

• object currencyType

{
    "description":"The letter of credit amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : locExpirationDate

The letter of credit expiration date.

Match All

The letter of credit expiration date.

Show Source

• object dateType

{
    "description":"The letter of credit expiration date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : locIssueDate

The letter of credit issue date.

Match All

The letter of credit issue date.

Show Source

• object dateType

{
    "description":"The letter of credit issue date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : locLatestShippingDate

The letter of credit latest shipping date.

Match All

The letter of credit latest shipping date.

Show Source

• object dateType

{
    "description":"The letter of credit latest shipping date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : locReceivedDate

The letter of credit received date.

Match All

The letter of credit received date.

Show Source

• object dateType

{
    "description":"The letter of credit received date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : orderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : planFromLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property planFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property planFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property planFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : planToLocation

The location from where the order is planned.

Match All

The location from where the order is planned.

Show Source

• object locations

{
    "description":"The location from where the order is planned.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ]
}

Nested Schema : portOfDisLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfLoadLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : primaryLegDestLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegDestLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegDestLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegDestLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : primaryLegSourceLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegSourceLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegSourceLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryLegSourceLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : quote

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property quoteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property quoteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property quoteGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/quotes"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryTVolume

The secondary total volume for the order that sums up the secondary weight values from the order release lines.

Match All

The secondary total volume for the order that sums up the secondary weight values from the order release lines.

Show Source

• object amountType

{
    "description":"The secondary total volume for the order that sums up the secondary weight values from the order release lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondaryTWeight

The secondary total weight for the order that sums up secondary weight values from the order release line.

Match All

The secondary total weight for the order that sums up secondary weight values from the order release line.

Show Source

• object amountType

{
    "description":"The secondary total weight for the order that sums up  secondary weight values from the order release line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : sellServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sellServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : services

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.services"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : shipUnitDiameter

The diameter of the ship unit for cyclindrical objects. This column will show value only if the order release has one ship unit.

Match All

The diameter of the ship unit for cyclindrical objects. This column will show value only if the order release has one ship unit.

Show Source

• object amountType

{
    "description":"The diameter of the ship unit for cyclindrical objects. This column will show value only if the order release has one ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : shipUnitHeight

The height of the ship unit. This column will show value only if the order release has one ship unit.

Match All

The height of the ship unit. This column will show value only if the order release has one ship unit.

Show Source

• object amountType

{
    "description":"The height of the ship unit. This column will show value only if the order release has one ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : shipUnitLength

The length of the ship unit. This column will show value only if the order release has one ship unit.

Match All

The length of the ship unit. This column will show value only if the order release has one ship unit.

Show Source

• object amountType

{
    "description":"The length of the ship unit. This column will show value only if the order release has one ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : shipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : shipUnitWidth

The width of the ship unit. This will show a value only if the order release has one ship unit.

Match All

The width of the ship unit. This will show a value only if the order release has one ship unit.

Show Source

• object amountType

{
    "description":"The width of the ship unit. This will show a value only if the order release has one ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : sourceLocation

The source location.

Match All

The source location.

Show Source

• object locations

{
    "description":"The source location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ]
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stops

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.stops"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stuffLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : surveyLayCanDate

The survey lay can date for the order release.

Match All

The survey lay can date for the order release.

Show Source

• object dateType

{
    "description":"The  survey lay can date for the order release.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalDeclaredValue

The total declared value calculated from the order release lines.

Match All

The total declared value calculated from the order release lines.

Show Source

• object currencyType

{
    "description":"The total declared value calculated from the order release lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalNetVolume

The total net volume calculated from the order release lines.

Match All

The total net volume calculated from the order release lines.

Show Source

• object amountType

{
    "description":"The total net volume calculated from the order release lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalNetWeight

The total net weight calculated from the order release lines.

Match All

The total net weight calculated from the order release lines.

Show Source

• object amountType

{
    "description":"The total net weight calculated from the order release lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalVolume

Read Only: true

The total volume calculated from the order release lines.

Match All

The total volume calculated from the order release lines.

Show Source

• object amountType

{
    "description":"The total volume calculated from the order release lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : totalWeight

Read Only: true

The total weight calculated from the order release lines.

Match All

The total weight calculated from the order release lines.

Show Source

• object amountType

{
    "description":"The total weight calculated from the order release lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : trackingEvents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.trackingEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : voyage

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/voyages"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code used to specify that this accessorial needs to be covered when planning the shipment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The accessorial code used to specify that this accessorial needs to be covered when planning the shipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.accruals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  If line accruals are enabled, this will be populated with the accessorial ID for the accrual line.
• accruedDate: accruedDate
  The date the amount was accrued.
• costTypeGid: string
  If line accruals are enabled, this will be populated with the cost type for the accrual line.
• delta: delta
  Delta or difference for the accrual calculated as: new amount - amount previously sent.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  The exchange rate date used for currency conversion calculation.
• exchangeRateGid: string
  The exchange rate GID used for currency conversion calculation.
• freightCost: freightCost
  The total current allocated freight costs.
• freightSentCost: freightSentCost
  Total allocated freight cost already sent via the accrual interface.
• isReversal: boolean
  A flag to determine whether the order release accrual is a reversal.
• links: array links
  Read Only: true
• orderReleaseAccrualGid: string
  The GID for this accrual entry.
• orderReleaseAccrualXid: string
  The XID for this accrual entry.
• sentDate: sentDate
  Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.
• shipmentGid: string
  The shipment GID associated to this accrual entry.
• shipmentStartDate: shipmentStartDate
  The shipment start date used for exchange rate calculations.

{
    "properties":{
        "orderReleaseAccrualGid":{
            "description":"The GID for this accrual entry.",
            "type":"string"
        },
        "orderReleaseAccrualXid":{
            "description":"The XID for this accrual entry.",
            "type":"string"
        },
        "sentDate":{
            "description":"Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "shipmentGid":{
            "description":"The shipment GID associated to this accrual entry.",
            "type":"string"
        },
        "accruedDate":{
            "description":"The date the amount was accrued.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "freightCost":{
            "description":"The total current allocated freight costs.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "freightSentCost":{
            "description":"Total allocated freight cost already sent via the accrual interface.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"The exchange rate GID used for currency conversion calculation.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"The exchange rate date used for currency conversion calculation.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "isReversal":{
            "description":"A flag to determine whether the order release accrual is a reversal.",
            "type":"boolean"
        },
        "shipmentStartDate":{
            "description":"The shipment start date used for exchange rate calculations.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "delta":{
            "description":"Delta or difference for the accrual calculated as: new amount - amount previously sent.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "costTypeGid":{
            "description":"If line accruals are enabled, this will be populated with the cost type for the accrual line.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"If line accruals are enabled, this will be populated with the accessorial ID for the accrual line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accruedDate

The date the amount was accrued.

Match All

The date the amount was accrued.

Show Source

• object dateTimeType

{
    "description":"The date the amount was accrued.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : delta

Delta or difference for the accrual calculated as: new amount - amount previously sent.

Match All

Delta or difference for the accrual calculated as: new amount - amount previously sent.

Show Source

• object currencyType

{
    "description":"Delta or difference for the accrual calculated as: new amount - amount previously sent.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

The exchange rate date used for currency conversion calculation.

Match All

The exchange rate date used for currency conversion calculation.

Show Source

• object dateType

{
    "description":"The exchange rate date used for currency conversion calculation.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : freightCost

The total current allocated freight costs.

Match All

The total current allocated freight costs.

Show Source

• object currencyType

{
    "description":"The total current allocated freight costs.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : freightSentCost

Total allocated freight cost already sent via the accrual interface.

Match All

Total allocated freight cost already sent via the accrual interface.

Show Source

• object currencyType

{
    "description":"Total allocated freight cost already sent via the accrual interface.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sentDate

Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.

Match All

Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.

Show Source

• object dateTimeType

{
    "description":"Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : shipmentStartDate

The shipment start date used for exchange rate calculations.

Match All

The shipment start date used for exchange rate calculations.

Show Source

• object dateTimeType

{
    "description":"The shipment start date used for exchange rate calculations.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.allocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• allocationBase: allocationBase
• allocSeqNo: number (int64)
  No description.
• baseCost: baseCost
  No description.
• details: details
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• links: array links
  Read Only: true
• privateCost: privateCost
  No description.
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• totalAllocCost: totalAllocCost
  No description.

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "privateCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "baseCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalAllocCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "allocationBase":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.allocations.allocationBase"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.allocations.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocationBase

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.allocations.allocationBase"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : baseCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.allocations.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : privateCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : totalAllocCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.allocations.allocationBase"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• allocatedCost: allocatedCost
  No description.
• allocSeqNo: number (int64)
  No description.
• allocTypeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• invoice: invoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• invoiceGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• parentInvoice: parentInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentInvoiceGid: string
  If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipGroup: shipGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipGroupGid: string
  Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
  group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• timestamp: timestamp
  No description.
• voucher: voucher
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voucherGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "invoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"If populated, the INVOICE_GID indicates that this alllocation is for a child invoice.  This column indicates the parent invoice of the entire consolidation that was allocated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "voucherGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voucher":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/vouchers"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : invoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : parentInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : shipGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : timestamp

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : voucher

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object vouchers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/vouchers"
        }
    ],
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• appointmentPriorityGid: string
  shipment group appointment priority used for dock scheduling priority feature
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• destLocation: destLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destLocationGid: string
  The destination location of the shipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  No description.
• endTime: endTime
  Indicates the end time of the shipment group.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  Indicates the equipment group ID for trailer build.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• links: array links
  Read Only: true
• numberOfShipments: number (int64)
  Total number of shipments in the shipment group
• orderReleaseDetails: orderReleaseDetails
• orDestLocationGid: string
  The Destination Location ID with which shipment group was created using a shipment group rule having Same Order Destination as true.
• orSourceLocationGid: string
  The Source Location ID with which the shipment group was created using a shipment group rule having Same Order Source as true.
• pickupTransactionNo: number (int64)
  No description.
• portOfDisLocationGid: string
  The Port of discharge ID with which the shipment group was created using a shipment group rule having Match Port of discharge as true.
• portOfLoadLocationGid: string
  The Port of loading ID with which shipment group was created using a shipment group rule having Match Port of loading as true.
• refnums: refnums
• remarks: remarks
• secondaryCharges: secondaryCharges
• sEquipmentGid: string
  The Equipment ID with which the shipment group was created using a shipment group rule having Same Equipment as true.
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The service provider for the trailer build. If the shipment group was created from a rule, the service provider will be copied to the shipment group matched from the rule.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipGroupGid: string
  The GID for the shipment group.
• shipGroupRuleGid: string
  Indicates the rule by which the shipment group is created.
• shipGroupTypeGid: string
  Indicates the shipment group type.
• shipGroupXid: string
  The XID for the shipment group.
• shipmentDetails: shipmentDetails
• sourceLocation: sourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourceLocationGid: string
  The source location of the shipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• startTime: startTime
  Indicates the start time of the shipment group.
• statuses: statuses
• totalVolume: totalVolume
  Total volume of all the shipments in the shipment group.
• totalWeight: totalWeight
  Total weight of all the shipments in the shipment group
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• userDefined2IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• userDefined3IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• userDefined4IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• userDefined5IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.
• voyageGid: string
  The Voyage ID with which the shipment group was created using a shipment group rule having Match Schedule as true.

{
    "properties":{
        "shipGroupGid":{
            "description":"The GID for the shipment group.",
            "type":"string"
        },
        "shipGroupXid":{
            "description":"The XID for the shipment group.",
            "type":"string"
        },
        "shipGroupTypeGid":{
            "description":"Indicates the shipment group type.",
            "type":"string"
        },
        "sourceLocationGid":{
            "description":"The source location of the shipment group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destLocationGid":{
            "description":"The destination location of the shipment group.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "shipGroupRuleGid":{
            "description":"Indicates the rule by which the shipment group is created.",
            "type":"string"
        },
        "startTime":{
            "description":"Indicates the start time of the shipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"Indicates the end time of the shipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "equipmentGroupGid":{
            "description":"Indicates the equipment group ID for trailer build.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "totalWeight":{
            "description":"Total weight of all the shipments in the shipment group",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"Total volume of all the shipments in the shipment group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "numberOfShipments":{
            "description":"Total number of shipments in the shipment group",
            "type":"number",
            "format":"int64"
        },
        "servprovGid":{
            "description":"The service provider for the trailer build. If the shipment group was created from a rule, the service provider will be copied to the shipment group matched from the rule. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "pickupTransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the shipment group.",
            "type":"string"
        },
        "appointmentPriorityGid":{
            "description":"shipment group appointment priority used for dock scheduling priority feature",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "voyageGid":{
            "description":"The Voyage ID with which the shipment group was created using a shipment group rule having Match Schedule as true.",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"The Port of loading ID with which shipment group was created using a shipment group rule having Match Port of loading as true.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"The Port of discharge ID with which the shipment group was created using a shipment group rule having Match Port of discharge as true.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The Equipment ID with which the shipment group was created using a shipment group rule having Same Equipment as true.",
            "type":"string"
        },
        "orSourceLocationGid":{
            "description":"The Source Location ID with which the shipment group was created using a shipment group rule having Same Order Source as true.",
            "type":"string"
        },
        "orDestLocationGid":{
            "description":"The Destination Location ID with which shipment group was created using a shipment group rule having Same Order Destination as true.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipmentDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.shipmentDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderReleaseDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "secondaryCharges":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.secondaryCharges"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : destLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : endTime

Indicates the end time of the shipment group.

Match All

Indicates the end time of the shipment group.

Show Source

• object dateTimeType

{
    "description":"Indicates the end time of the shipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderReleaseDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryCharges

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.secondaryCharges"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : shipmentDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.shipmentDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : startTime

Indicates the start time of the shipment group.

Match All

Indicates the start time of the shipment group.

Show Source

• object dateTimeType

{
    "description":"Indicates the start time of the shipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalVolume

Total volume of all the shipments in the shipment group.

Match All

Total volume of all the shipments in the shipment group.

Show Source

• object amountType

{
    "description":"Total volume of all the shipments in the shipment group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

Total weight of all the shipments in the shipment group

Match All

Total weight of all the shipments in the shipment group

Show Source

• object amountType

{
    "description":"Total weight of all the shipments in the shipment group",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The communication method GID related to the involved party.
• domainName: string
  No description.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The contact GID for the involved party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The qualifier GID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier GID for the involved party. ",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact GID for the involved party.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method GID related to the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• domainName: string
  No description.
• links: array links
  Read Only: true
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  The order release of shipments in the shipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• orderReleaseLine: orderReleaseLine
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseLineGid: string
  The order release lines of shipments in the shipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• remarks: remarks
• seqNum: number (int64)
  The sequence number to make the record unique.
• sEquipment: sEquipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sEquipmentGid: string
  The equipment for the shipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  The GID of shipment in the shipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "shipmentGid":{
            "description":"The GID of shipment in the shipment group.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "sEquipmentGid":{
            "description":"The equipment for the shipment group.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sEquipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sEquipments"
                }
            ],
            "readOnly":true
        },
        "orderReleaseGid":{
            "description":"The order release of shipments in the shipment group.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "seqNum":{
            "description":"The sequence number to make the record unique. ",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseLineGid":{
            "description":"The order release lines of shipments in the shipment group.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderReleaseLine":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleaseLines"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : orderReleaseLine

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object orderReleaseLines

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleaseLines"
        }
    ],
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sEquipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object sEquipments

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sEquipments"
        }
    ],
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : orderReleaseLines

Type: object

Show Source

• accessorials: accessorials
• allocations: allocations
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributes: attributes
• billedQuantity: number (double)
  The billed quantity for order release line goods.
• billedQuantityUomCode: string
  The billed quantity unit of measure.
• billedQuantityUomType: string
  The billed quantity unit of measure type.
• brandName: string
  The brand name. For informational purposes.
• buyGeneralLedgerGid: string
  The general ledger code for the order release line for the buy side (cost).
• commercialInvoiceDescription: string
  A description field for the commercial invoice.
• commercialInvoiceGid: string
  The commercial invoice GID for the object that is associated with this order release line.
• declaredValue: declaredValue
  The declared cost of the item.
• domainName: string
  Database domain where this data is stored.
• equipmentRefUnits: equipmentRefUnits
• freeAlongSide: freeAlongSide
  Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.
• hazActivity: string
  The hazardous activity field indicates the level of radioactivity of the product.
• hazAllPacked: boolean
  Flag to indicate the package is "All packed in one".
• hazApprovalExemptionGid: string
  The hazardous approval exemption GID.
• hazardousClassificationGid: string
  The hazardous classification GID.
• hazAuthorization: string
  The authorization for the dangerous goods shipment. The authorization field is only required to state special governmental authorizations that are required because of the provisions or packing materials shipped with.
• hazChemicalFormula: string
  The basic chemical description of the substance.
• hazCompatibilityGroup: string
  The hazardous material compatibility group associated to the order release line.
• hazConcentrationPercent: number (double)
  Required if the dangerous goods UN number is 2031, 1796, 1826, or 1873. Enter the percentage of dangerous goods concentration if the above condition applies.
• hazControlTemp: hazControlTemp
  The hazardous control temperature to report for this order release line.
• hazCritSafetyIndex: number (double)
  A measurement for packages containing fissile material that is determined by dividing the number 50 by the smaller of the numbers determined using the rules in section 10.6.2.4.3 of the IATA Dangerous Goods Regulation Guide.
• hazEmergencyResponseInfo: string
  The emergency response information is a number associated with the International Maritime Organization (IMO), which promulgates, encourages, and enforces the highest standards of marine safety in vessel transport. Enter an IMDG emergency response number for this hazardous material.
• hazEmergencyTemp: hazEmergencyTemp
  The emergency temperature at which the product will begin the process of self-destructing or breaking down.
• hazEms: string
  The EMS (Emergency aboard Ship) field. The page number is required for documentation.
• hazErg: string
  The ERG (Emergency Response Guide) field. The page number is required for documentation purposes.
• hazErgAir: string
  The ERG (Emergency Response Guide) field for air. The page number is required for documentation purposes.
• hazExtCode: string
  The item hazmat code as configured in the TNT EM. (For carrier TNT).
• hazFlashPoint: hazFlashPoint
  The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.
• hazHazardousDescription: string
  A hazardous description for documentation.
• hazHazmatGenericGid: string
  The hazmat generic GID is the link between a hazardous material and a hazardous item.
• hazHazmatItemGid: string
  The hazmat item GID defines the entry in the hazmat table that contains attributes associated to this order release line.
• hazIdentificationNumber: string
  The hazardous classification ID is the numeric class of the hazardous material as specified by Department of Transportation regulations. Enter the hazard class in this field.
• hazIdgAddDescInfo: string
  The hazmat IDG additional description information.
• hazInhalationHazardZone: string
  This zone indicates the area of a toxicity hazard based on the concentration of the hazardous material.
• hazIsCommercialAircraftFor: boolean
  A Y/N indicator specifying the commercial aircraft forbidden indicator if the material cannot be transported on passenger aircraft.
• hazIsLimitedQuantity: boolean
  A Y/N indicator for the limited quantity residual amounts.
• hazIsMarinePollutant: boolean
  A Y/N indicator defining this order as a marine pollutant.
• hazIsNos: boolean
  A Y/N indicator defining this order release line as a hazardous not otherwise specified.
• hazIsOilContained: boolean
  A Y/N indicator that the check hazardous is oil contained field if the material is an oil-based product.
• hazIsOverpack: boolean
  Flag to indicate the package is an "overpack".
• hazIsPassengerAircraftForb: boolean
  A Y/N indicator specifying the passenger aircraft forbidden indicator if the material cannot be transported on passenger aircraft.
• hazIsReportableQuantity: boolean
  A Y/N indicator, the reportable quantity (RQ) indicator if the material is composed of quantities of other chemicals that are hazardous and must be reported by concentration percentage. RQs are the chemical components of a hazardous item that have reached a threshold in a shipping container that make them reportable as hazardous items.
• hazIsToxicInhalation: boolean
  A Y/N indicator defining the hazardous toxic inhalation value.
• hazMaxQuantity: number (double)
  The maximum passenger volume or the maximum cargo volume for the item. Used in Q- Value calculation.
• hazMpTechnicalName: string
  The marine pollutant technical name for this hazardous substance.
• hazMpTechnicalName2: string
  The marine pollutant technical name for this hazardous substance. You can specify up to 2.
• hazNetExplosvContentWeight: hazNetExplosvContentWeight
  The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.
• hazNosTechnicalName: string
  The Not Otherwise Specified (NOS) indicator if the material is composed of other chemicals not specified add the technical name.
• hazNosTechnicalName2: string
  The not otherwise specified (NOS) field if the material is composed of other chemicals not specified add the technical name. You can specify up to 2.
• hazOuterPackagingType: string
  Outer packaging type if packing type = All packed in one.
• hazOuterPackingCount: number (double)
  The outer packing count.
• hazPackageType: string
  The hazmat package type of the dangerous goods shipment.
• hazPackagingGroup: string
  The packaging group denotes the classification of hazardous packaging for this material based on the reportable quantity of the material.
• hazPackingCount: number (double)
  The packing count (number of packaged units).
• hazPackingInstructions: string
  Required for dangerous goods shipments, unless the dangerous goods class is radioactive or not restricted. See Table 4.2 columns G, I, or K of the IATA Dangerous Goods Regulation Guide.
• hazPhysicalForm: string
  A description of the physical form of the radioactive substance: S(p)ecial, (S)olid, (L)iquid, (G)as.
• hazProperShippingName: string
  The hazardous proper shipping name for the hazardous material is similar, but not identical to, the hazardous technical name of the material.
• hazPsaSingaporeGroup: string
  For the hazardous PSA Singapore Group enter a I, II, OR III. This regulates the cost of hazardous charge/cost at the Singapore destination.
• hazQuantity: number (double)
  The hazmat item quantity.
• hazQValue: number (double)
  The ratio used to indicate that the combined quantities in "all packed in one" package are within the maximum allowable limits.
• hazRadioactiveLabel: string
  The type of label on the shipment. W1 (White I), Y2 (Yellow II), Y3 (Yellow III).
• hazRadioactivity: number (double)
  A measurement of the activity of the shipment. For fissile material, the weight of the material in grams or kilograms may be substituted for the activity measurement.
• hazRadioactivityUnits: string
  The units that the activity were measured in. This must be in Becquerel units (or multiples thereof): Bq (Becquerel), kBq (kilobecquerel), MBq (megabecquerel), GBq (gigabecquerel), TBq (terabecquerel), PBq (petabecquerel).
• hazRadionuclide: string
  The radionuclide assigned to the substance being shipped. A table of basic radionuclides is available in the IATA Dangerous Goods Regulation Guide section 10.4.A. For example, aluminum (13) has a radionuclide Al-26.
• hazRadPackaging: string
  A description of the type of packaging the substance is contained in. Acceptable package types are listed in section 10.5 of the dangerous goods regulations guide: Expected (Expected), Industrial ip1 (Industrial Type 1(IP-1)), Industrial ip2 (Industrial Type 2(IP-2)), Industrial ip3 (Industrial Type 3(IP-3)), Type a (Type A), Type b(m) ( Type B(M)), Type b(u) ( Type B(U)), Type c ( Type C ).
• hazRqTechnicalName: string
  The reportable quantity technical name.
• hazRqTechnicalName2: string
  The reportable quantity technical name. You can specify up to 2.
• hazSpecialProvisions: string
  Indicates dangerous goods (DG) are being shipped under one of the special provisions listed in the IATA Dangerous Goods Regulation Guide, section 4.4. There appear to be 146 different provisions, and multiple provisions may apply to a single item in some cases.
• hazSubsidiaryHazard: string
  The subsidiary hazard represents a Department of Transportation-specified code pertaining to the cleanup of a spill of a hazardous material.
• hazSubstanceNumber: string
  The hazardous materials substance number.
• hazSurfaceReading: number (double)
  The surface reading of the radiation exposure for the package. This reading must be measured in mrem/h.
• hazTransportIndex: number (double)
  A number based on the radiation exposure of a package. This is determined based on the maximum measurement of the radiation in mrem/h at a distance of 1 meter from the package surface.
• hazType: string
  The hazardous materials type. Valid values are: l = Limited Quantities, e = 500 KG Exemption, f = Fully Regulated (Purolater).
• hazUnits: string
  IATA units for non UPS shipments (L=>Liters g=>Grams kg=>Kilograms kg G=>Kilograms Gross).
• initialItem: initialItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• initialItemGid: string
  Can be used to define the substitution.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isDrawback: boolean
  A Y/N indicator defining if this order release line is part of the duty drawback program.
• isHazardous: boolean
  A Y/N indicator defining if the order release line is a hazardous goods. This is a transactional setting instead of looking at the item master definitions.
• isSplitAllowed: boolean
  Indicates if the order release ship units that are created can be split into multiple pieces of equipment.
• itemPackageCount: number (int64)
  The packaging unit count associated to the packaging unit for this order release line.
• links: array links
  Read Only: true
• loadConfigSetupGid: string
  A load configuration set up identifier to be used by the load configuration engine as the input rules during ship unit building.
• manufacturedCountryCodeGid: string
  The country code GID where this order release line was manufactured.
• numLayersPerShipUnit: number (int64)
  The number of layers for the transportation handling unit defined here on the order base line. This allows the user to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.
• obLineGid: string
  The order base line from which this order release line was built.
• obLineRelInstrSeq: number (int64)
  The order base line release instruction sequence number, carried over from column OB_RELEASE_INSTRUCTION_SEQ in table OB_RELEASE_INSTRUCTION when the order release line is created from an order base line.
• orderBase: orderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderBaseGid: string
  The order base from which this order release line was built.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  A GID created by the system for the order release.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• orderReleaseLineGid: string
  The GID for the order base line.
• orderReleaseLineXid: string
  The XID for the order base line.
• packageCoreDiameter: packageCoreDiameter
  The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.
• packageDiameter: packageDiameter
  The package diameter for order release line; overrides diameter on packaged item.
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item GID defining the item associated to this order release line.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packageHeight: packageHeight
  The package height for order release line; overrides height on packaged item.
• packageLength: packageLength
  The package length for order release line; overrides length on packaged item.
• packageRefUnits: packageRefUnits
• packageWidth: packageWidth
  The package width for order release line; overrides width on packaged item.
• packagingUnitCount: number (int64)
  The packaging unit count associated to the packaging unit for this order base line.
• packagingUnitGid: string
  The packaging unit (considered an inner pack to the packaged item level) for this order release line.
• packWithGroup: string
  Lines with different Pack with Groups cannot be packed into the same ship unit.
• pricePerUnit: pricePerUnit
  The price per unit for the order release line to indicate the amount billed.
• pricePerUnitUomCode: string
  The unit of measurement this unit price is based on.
• quantityPerLayer: number (int64)
  The quantity per layer for the transportation handling unit defined here on the order base line. This allows the user to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.
• refnums: refnums
• remarks: remarks
• secondaryVolume: secondaryVolume
  The order release line can be specified in a secondary volume value for informational purposes.
• secondaryWeight: secondaryWeight
  The order release line can be specified in a secondary weight value for informational purposes.
• sellGeneralLedgerGid: string
  The general ledger code for the order release line for the sell side (revenue).
• specialServices: specialServices
• tag1: string
  Additional information about the item. Like the color, size, or code.
• tag2: string
  Additional information about the item. Like the color, size, or code.
• tag3: string
  Additional information about the item. Like the color, size, or code.
• tag4: string
  Additional information about the item. Like the color, size, or code.
• texts: texts
• thuProfileGid: string
  The transport handling unit profile (list of valid THUs for this order line) that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged item table.
• totalBilledAmt: totalBilledAmt
  The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.
• transportHandlingUnitGid: string
  The transport handling unit that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged item table.
• updateDate: updateDate
  Read Only: true

  update date
• volume: volume
  The volume of the item.
• weight: weight
  The weight of the item.

{
    "properties":{
        "orderReleaseLineGid":{
            "description":"The GID for the order base line.",
            "type":"string"
        },
        "orderReleaseLineXid":{
            "description":"The XID for the order base line.",
            "type":"string"
        },
        "orderReleaseGid":{
            "description":"A GID created by the system for the order release. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "weight":{
            "description":"The weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tag1":{
            "description":"Additional information about the item. Like the color, size, or code.",
            "type":"string"
        },
        "tag2":{
            "description":"Additional information about the item. Like the color, size, or code.",
            "type":"string"
        },
        "tag3":{
            "description":"Additional information about the item. Like the color, size, or code.",
            "type":"string"
        },
        "tag4":{
            "description":"Additional information about the item. Like the color, size, or code.",
            "type":"string"
        },
        "declaredValue":{
            "description":"The declared cost of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "initialItemGid":{
            "description":"Can be used to define the substitution. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "initialItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "packagingUnitGid":{
            "description":"The packaging unit (considered an inner pack to the packaged item level) for this order release line.",
            "type":"string"
        },
        "itemPackageCount":{
            "description":"The packaging unit count associated to the packaging unit for this order release line.",
            "type":"number",
            "format":"int64"
        },
        "packagedItemGid":{
            "description":"The packaged item GID defining the item associated to this order release line. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "buyGeneralLedgerGid":{
            "description":"The general ledger code for the order release line for the buy side (cost).",
            "type":"string"
        },
        "sellGeneralLedgerGid":{
            "description":"The general ledger code for the order release line for the sell side (revenue).",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count associated to the packaging unit for this order base line.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged item table.",
            "type":"string"
        },
        "numLayersPerShipUnit":{
            "description":"The number of layers for the transportation handling unit defined here on the order base line. This allows the user to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.",
            "type":"number",
            "format":"int64"
        },
        "quantityPerLayer":{
            "description":"The quantity per layer for the transportation handling unit defined here on the order base line. This allows the user to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.",
            "type":"number",
            "format":"int64"
        },
        "freeAlongSide":{
            "description":"Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isHazardous":{
            "description":"A Y/N indicator defining if the order release line is a hazardous goods. This is a transactional setting instead of looking at the item master definitions.",
            "type":"boolean"
        },
        "commercialInvoiceGid":{
            "description":"The commercial invoice GID for the object that is associated with this order release line.",
            "type":"string"
        },
        "commercialInvoiceDescription":{
            "description":"A description field for the commercial invoice.",
            "type":"string"
        },
        "secondaryWeight":{
            "description":"The order release line can be specified in a secondary weight value for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondaryVolume":{
            "description":"The order release line can be specified in a secondary volume value for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazHazmatGenericGid":{
            "description":"The hazmat generic GID is the link between a hazardous material and a hazardous item.",
            "type":"string"
        },
        "hazHazmatItemGid":{
            "description":"The hazmat item GID defines the entry in the hazmat table that contains attributes associated to this order release line.",
            "type":"string"
        },
        "hazIdentificationNumber":{
            "description":"The hazardous classification ID is the numeric class of the hazardous material as specified by Department of Transportation regulations. Enter the hazard class in this field.",
            "type":"string"
        },
        "hazProperShippingName":{
            "description":"The hazardous proper shipping name for the hazardous material is similar, but not identical to, the hazardous technical name of the material.",
            "type":"string"
        },
        "hazPackagingGroup":{
            "description":"The packaging group denotes the classification of hazardous packaging for this material based on the reportable quantity of the material.",
            "type":"string"
        },
        "hazFlashPoint":{
            "description":"The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazEmergencyTemp":{
            "description":"The emergency temperature at which the product will begin the process of self-destructing or breaking down.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazControlTemp":{
            "description":"The hazardous control temperature to report for this order release line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazSubsidiaryHazard":{
            "description":"The subsidiary hazard represents a Department of Transportation-specified code pertaining to the cleanup of a spill of a hazardous material. ",
            "type":"string"
        },
        "hazInhalationHazardZone":{
            "description":"This zone indicates the area of a toxicity hazard based on the concentration of the hazardous material.",
            "type":"string"
        },
        "hazEmergencyResponseInfo":{
            "description":"The emergency response information is a number associated with the International Maritime Organization (IMO), which promulgates, encourages, and enforces the highest standards of marine safety in vessel transport. Enter an IMDG emergency response number for this hazardous material.",
            "type":"string"
        },
        "hazNosTechnicalName":{
            "description":" The Not Otherwise Specified (NOS) indicator if the material is composed of other chemicals not specified add the technical name.",
            "type":"string"
        },
        "hazNetExplosvContentWeight":{
            "description":"The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazMpTechnicalName":{
            "description":"The marine pollutant technical name for this hazardous substance.",
            "type":"string"
        },
        "hazIsLimitedQuantity":{
            "description":"A Y/N indicator for the limited quantity residual amounts.",
            "type":"boolean"
        },
        "hazPsaSingaporeGroup":{
            "description":"For the hazardous PSA Singapore Group enter a I, II, OR III. This regulates the cost of hazardous charge/cost at the Singapore destination.",
            "type":"string"
        },
        "hazHazardousDescription":{
            "description":"A hazardous description for documentation.",
            "type":"string"
        },
        "hazIsReportableQuantity":{
            "description":"A Y/N indicator, the reportable quantity (RQ) indicator if the material is composed of quantities of other chemicals that are hazardous and must be reported by concentration percentage. RQs are the chemical components of a hazardous item that have reached a threshold in a shipping container that make them reportable as hazardous items.",
            "type":"boolean"
        },
        "hazRqTechnicalName":{
            "description":"The reportable quantity technical name.",
            "type":"string"
        },
        "hazActivity":{
            "description":"The hazardous activity field indicates the level of radioactivity of the product.",
            "type":"string"
        },
        "hazIsToxicInhalation":{
            "description":"A Y/N indicator defining the hazardous toxic inhalation value.",
            "type":"boolean"
        },
        "hazIsPassengerAircraftForb":{
            "description":"A Y/N indicator specifying the passenger aircraft forbidden indicator if the material cannot be transported on passenger aircraft.",
            "type":"boolean"
        },
        "hazIsCommercialAircraftFor":{
            "description":"A Y/N indicator specifying the commercial aircraft forbidden indicator if the material cannot be transported on passenger aircraft.",
            "type":"boolean"
        },
        "hazIsOilContained":{
            "description":"A Y/N indicator that the check hazardous is oil contained field if the material is an oil-based product.",
            "type":"boolean"
        },
        "hazNosTechnicalName2":{
            "description":"The not otherwise specified (NOS) field if the material is composed of other chemicals not specified add the technical name. You can specify up to 2.",
            "type":"string"
        },
        "hazRqTechnicalName2":{
            "description":"The reportable quantity technical name. You can specify up to 2.",
            "type":"string"
        },
        "hazMpTechnicalName2":{
            "description":"The marine pollutant technical name for this hazardous substance. You can specify up to 2.",
            "type":"string"
        },
        "hazardousClassificationGid":{
            "description":"The hazardous classification GID.",
            "type":"string"
        },
        "manufacturedCountryCodeGid":{
            "description":"The country code GID where this order release line was manufactured.",
            "type":"string"
        },
        "isDrawback":{
            "description":"A Y/N indicator defining if this order release line is part of the duty drawback program.",
            "type":"boolean"
        },
        "billedQuantity":{
            "description":"The billed quantity for order release line goods.",
            "type":"number",
            "format":"double"
        },
        "billedQuantityUomCode":{
            "description":"The billed quantity unit of measure.",
            "type":"string"
        },
        "billedQuantityUomType":{
            "description":"The billed quantity unit of measure type.",
            "type":"string"
        },
        "pricePerUnit":{
            "description":"The price per unit for the order release line to indicate the amount billed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalBilledAmt":{
            "description":"The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "brandName":{
            "description":"The brand name. For informational purposes.",
            "type":"string"
        },
        "hazIsNos":{
            "description":"A Y/N indicator defining this order release line as a hazardous not otherwise specified.",
            "type":"boolean"
        },
        "hazIsMarinePollutant":{
            "description":"A Y/N indicator defining this order as a marine pollutant.",
            "type":"boolean"
        },
        "hazErg":{
            "description":"The ERG (Emergency Response Guide) field. The page number is required for documentation purposes.",
            "type":"string"
        },
        "hazErgAir":{
            "description":"The ERG (Emergency Response Guide) field for air. The page number is required for documentation purposes.",
            "type":"string"
        },
        "hazEms":{
            "description":"The EMS (Emergency aboard Ship) field. The page number is required for documentation.",
            "type":"string"
        },
        "pricePerUnitUomCode":{
            "description":"The unit of measurement this unit price is based on.",
            "type":"string"
        },
        "hazCompatibilityGroup":{
            "description":"The hazardous material compatibility group associated to the order release line.",
            "type":"string"
        },
        "packageLength":{
            "description":"The package length for order release line; overrides length on packaged item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageWidth":{
            "description":"The package width for order release line; overrides width on packaged item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageHeight":{
            "description":"The package height for order release line; overrides height on packaged item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageDiameter":{
            "description":"The package diameter for order release line; overrides diameter on packaged item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageCoreDiameter":{
            "description":"The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "orderBaseGid":{
            "description":"The order base from which this order release line was built. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "obLineGid":{
            "description":"The order base line from which this order release line was built.",
            "type":"string"
        },
        "hazAllPacked":{
            "description":"Flag to indicate the package is \"All packed in one\".",
            "type":"boolean"
        },
        "hazAuthorization":{
            "description":"The authorization for the dangerous goods shipment. The authorization field is only required to state special governmental authorizations that are required because of the provisions or packing materials shipped with. ",
            "type":"string"
        },
        "hazChemicalFormula":{
            "description":"The basic chemical description of the substance.",
            "type":"string"
        },
        "hazConcentrationPercent":{
            "description":"Required if the dangerous goods UN number is 2031, 1796, 1826, or 1873. Enter the percentage of dangerous goods concentration if the above condition applies.",
            "type":"number",
            "format":"double"
        },
        "hazCritSafetyIndex":{
            "description":"A measurement for packages containing fissile material that is determined by dividing the number 50 by the smaller of the numbers determined using the rules in section 10.6.2.4.3 of the IATA Dangerous Goods Regulation Guide.",
            "type":"number",
            "format":"double"
        },
        "hazApprovalExemptionGid":{
            "description":"The hazardous approval exemption GID.",
            "type":"string"
        },
        "hazIdgAddDescInfo":{
            "description":"The hazmat IDG additional description information.",
            "type":"string"
        },
        "hazMaxQuantity":{
            "description":"The maximum passenger volume or the maximum cargo volume for the item. Used in Q- Value calculation.",
            "type":"number",
            "format":"double"
        },
        "hazOuterPackagingType":{
            "description":"Outer packaging type if packing type = All packed in one.",
            "type":"string"
        },
        "hazOuterPackingCount":{
            "description":"The outer packing count.",
            "type":"number",
            "format":"double"
        },
        "hazIsOverpack":{
            "description":"Flag to indicate the package is an \"overpack\".",
            "type":"boolean"
        },
        "hazPackageType":{
            "description":"The hazmat package type of the dangerous goods shipment.",
            "type":"string"
        },
        "hazPackingCount":{
            "description":"The packing count (number of packaged units).",
            "type":"number",
            "format":"double"
        },
        "hazPackingInstructions":{
            "description":"Required for dangerous goods shipments, unless the dangerous goods class is radioactive or not restricted. See Table 4.2 columns G, I, or K of the IATA Dangerous Goods Regulation Guide.",
            "type":"string"
        },
        "hazPhysicalForm":{
            "description":"A description of the physical form of the radioactive substance: S(p)ecial, (S)olid, (L)iquid, (G)as.",
            "type":"string"
        },
        "hazQValue":{
            "description":"The ratio used to indicate that the combined quantities in \"all packed in one\" package are within the maximum allowable limits.",
            "type":"number",
            "format":"double"
        },
        "hazQuantity":{
            "description":"The hazmat item quantity.",
            "type":"number",
            "format":"double"
        },
        "hazRadioactiveLabel":{
            "description":"The type of label on the shipment. W1 (White I), Y2 (Yellow II), Y3 (Yellow III).",
            "type":"string"
        },
        "hazRadPackaging":{
            "description":"A description of the type of packaging the substance is contained in. Acceptable package types are listed in section 10.5 of the dangerous goods regulations guide: Expected (Expected), Industrial ip1 (Industrial Type 1(IP-1)), Industrial ip2 (Industrial Type 2(IP-2)), Industrial ip3 (Industrial Type 3(IP-3)), Type a (Type A), Type b(m) ( Type B(M)), Type b(u) ( Type B(U)), Type c ( Type C ).",
            "type":"string"
        },
        "hazRadioactivity":{
            "description":"A measurement of the activity of the shipment. For fissile material, the weight of the material in grams or kilograms may be substituted for the activity measurement.",
            "type":"number",
            "format":"double"
        },
        "hazRadioactivityUnits":{
            "description":"The units that the activity were measured in. This must be in Becquerel units (or multiples thereof): Bq (Becquerel), kBq (kilobecquerel), MBq (megabecquerel), GBq (gigabecquerel), TBq (terabecquerel), PBq (petabecquerel).",
            "type":"string"
        },
        "hazRadionuclide":{
            "description":"The radionuclide assigned to the substance being shipped. A table of basic radionuclides is available in the IATA Dangerous Goods Regulation Guide section 10.4.A.  For example, aluminum (13) has a radionuclide Al-26.",
            "type":"string"
        },
        "hazSpecialProvisions":{
            "description":"Indicates dangerous goods (DG) are being shipped under one of the special provisions listed in the IATA Dangerous Goods Regulation Guide, section 4.4.  There appear to be 146 different provisions, and multiple provisions may apply to a single item in some cases. ",
            "type":"string"
        },
        "hazSubstanceNumber":{
            "description":"The hazardous materials substance number. ",
            "type":"string"
        },
        "hazSurfaceReading":{
            "description":"The surface reading of the radiation exposure for the package. This reading must be measured in mrem/h.",
            "type":"number",
            "format":"double"
        },
        "hazTransportIndex":{
            "description":"A number based on the radiation exposure of a package. This is determined based on the maximum measurement of the radiation in mrem/h at a distance of 1 meter from the package surface.",
            "type":"number",
            "format":"double"
        },
        "hazType":{
            "description":"The hazardous materials type. Valid values are: l = Limited Quantities, e = 500 KG Exemption, f = Fully Regulated (Purolater).",
            "type":"string"
        },
        "hazUnits":{
            "description":"IATA units for non UPS shipments (L=>Liters g=>Grams kg=>Kilograms kg G=>Kilograms Gross).",
            "type":"string"
        },
        "hazExtCode":{
            "description":"The item hazmat code as configured in the TNT EM. (For carrier TNT).",
            "type":"string"
        },
        "thuProfileGid":{
            "description":"The transport handling unit profile (list of valid THUs for this order line) that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged item table.",
            "type":"string"
        },
        "obLineRelInstrSeq":{
            "description":"The order base line release instruction sequence number, carried over from column OB_RELEASE_INSTRUCTION_SEQ in table OB_RELEASE_INSTRUCTION when the order release line is created from an order base line.",
            "type":"number",
            "format":"int64"
        },
        "isSplitAllowed":{
            "description":"Indicates if the order release ship units that are created can be split into multiple pieces of equipment.",
            "type":"boolean"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "packWithGroup":{
            "description":"Lines with different Pack with Groups cannot be packed into the same ship unit.",
            "type":"string"
        },
        "loadConfigSetupGid":{
            "description":"A load configuration set up identifier to be used by the load configuration engine as the input rules during ship unit building.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "attributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.attributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "packageRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.packageRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "allocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.allocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.allocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.attributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

The declared cost of the item.

Match All

The declared cost of the item.

Show Source

• object currencyType

{
    "description":"The declared cost of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : freeAlongSide

Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.

Match All

Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.

Show Source

• object currencyType

{
    "description":"Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : hazControlTemp

The hazardous control temperature to report for this order release line.

Match All

The hazardous control temperature to report for this order release line.

Show Source

• object amountType

{
    "description":"The hazardous control temperature to report for this order release line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : hazEmergencyTemp

The emergency temperature at which the product will begin the process of self-destructing or breaking down.

Match All

The emergency temperature at which the product will begin the process of self-destructing or breaking down.

Show Source

• object amountType

{
    "description":"The emergency temperature at which the product will begin the process of self-destructing or breaking down.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : hazFlashPoint

The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.

Match All

The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.

Show Source

• object amountType

{
    "description":"The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : hazNetExplosvContentWeight

The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.

Match All

The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.

Show Source

• object amountType

{
    "description":"The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : initialItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : packageCoreDiameter

The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.

Match All

The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.

Show Source

• object amountType

{
    "description":"The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageDiameter

The package diameter for order release line; overrides diameter on packaged item.

Match All

The package diameter for order release line; overrides diameter on packaged item.

Show Source

• object amountType

{
    "description":"The package diameter for order release line; overrides diameter on packaged item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : packageHeight

The package height for order release line; overrides height on packaged item.

Match All

The package height for order release line; overrides height on packaged item.

Show Source

• object amountType

{
    "description":"The package height for order release line; overrides height on packaged item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageLength

The package length for order release line; overrides length on packaged item.

Match All

The package length for order release line; overrides length on packaged item.

Show Source

• object amountType

{
    "description":"The package length for order release line; overrides length on packaged item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.packageRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : packageWidth

The package width for order release line; overrides width on packaged item.

Match All

The package width for order release line; overrides width on packaged item.

Show Source

• object amountType

{
    "description":"The package width for order release line; overrides width on packaged item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pricePerUnit

The price per unit for the order release line to indicate the amount billed.

Match All

The price per unit for the order release line to indicate the amount billed.

Show Source

• object currencyType

{
    "description":"The price per unit for the order release line to indicate the amount billed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryVolume

The order release line can be specified in a secondary volume value for informational purposes.

Match All

The order release line can be specified in a secondary volume value for informational purposes.

Show Source

• object amountType

{
    "description":"The order release line can be specified in a secondary volume value for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondaryWeight

The order release line can be specified in a secondary weight value for informational purposes.

Match All

The order release line can be specified in a secondary weight value for informational purposes.

Show Source

• object amountType

{
    "description":"The order release line can be specified in a secondary weight value for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalBilledAmt

The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.

Match All

The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.

Show Source

• object currencyType

{
    "description":"The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : volume

The volume of the item.

Match All

The volume of the item.

Show Source

• object amountType

{
    "description":"The volume of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight of the item.

Match All

The weight of the item.

Show Source

• object amountType

{
    "description":"The weight of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• links: array links
  Read Only: true
• remarks: remarks

{
    "properties":{
        "accessorialCodeGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.accessorials.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.accessorials.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.accessorials.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The remark sequence associated with the order release line
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence associated with the order release line",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.allocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• allocationBase: allocationBase
• allocSeqNo: number (int64)
  No description.
• baseCost: baseCost
  No description.
• details: details
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• links: array links
  Read Only: true
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  A unique identifier created by the system for the order release. the gid contains the domain portion.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• privateCost: privateCost
  No description.
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• totalAllocLineCost: totalAllocLineCost
  No description.

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "orderReleaseGid":{
            "description":"A unique identifier created by the system for the order release. the gid contains the domain portion. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "privateCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "baseCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalAllocLineCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packagedItemGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "allocationBase":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.allocations.allocationBase"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleaseLines.allocations.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocationBase

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.allocations.allocationBase"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : baseCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleaseLines.allocations.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : privateCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : totalAllocLineCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.allocations.allocationBase"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• allocatedCost: allocatedCost
  No description.
• allocSeqNo: number (int64)
  No description.
• allocTypeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• invoice: invoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• invoiceGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• parentInvoice: parentInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentInvoiceGid: string
  If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipGroup: shipGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipGroupGid: string
  Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
  group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• timestamp: timestamp
  No description.
• voucher: voucher
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voucherGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "invoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"If populated, the INVOICE_GID indicates that this alllocation is for a child invoice.  This column indicates the parent invoice of the entire consolidation that was allocated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "voucherGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voucher":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/vouchers"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : invoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : parentInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : shipGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : timestamp

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : voucher

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object vouchers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/vouchers"
        }
    ],
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorials: accessorials
• actualCo2Emission: actualCo2Emission
  Actual CO2 emissions for the shipment.
• actualCo2EqEmission: actualCo2EqEmission
  Actual CO2 equivalent emissions for the shipment.
• aheadLateTime: aheadLateTime
  shipment status
• aheadOrLate: string
  A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user. B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed
• airRailRouteCode: string
  A transportation mode code that is informational for the shipment.
• allocations: allocations
• appointmentPriorityGid: string
  The appointment priority identifier associated with the shipment.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeCurrency2: attributeCurrency2
  The attribute currency of the shipment.
• attributeCurrency3: attributeCurrency3
  The attribute currency of the shipment.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• bolIssuanceType: string
  The bill of lading issuance type identifier.
• bolType: string
  The bill of lading type defined for the shipment, used for report management.
• bulkCmGid: string
  The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.
• bulkPlanGid: string
  Read Only: true

  If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.
• cfsCutoffDate: cfsCutoffDate
  The container freight station cutoff date associated with the shipment.
• cfsLocation: cfsLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cfsLocationGid: string
  The location identifier for the container freight station.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• chargeableVolume: chargeableVolume
  Read Only: true

  The actual volume used in calculating the cost of the shipment.
• chargeableWeight: chargeableWeight
  Read Only: true

  The dimensional weight as determined by the rating process.
• checkCapacityConstraint: boolean
  The indicator to check the capacity constraints associated with the shipment.
• checkCostConstraint: boolean
  The indicator to check cost constraints associated with the shipment
• checkTimeConstraint: boolean
  The indicator to check the time constraints associated with the shipment.
• cmCost: cmCost
  The shipment cost when the shipment is part of a continuous move tour.
• cmEmptyDistance: cmEmptyDistance
  The empty leg distance between previous and this shipments.
• cmName: string
  Read Only: true

  The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.
• cmNextSourceLocation: cmNextSourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cmNextSourceLocationGid: string
  The source location of the next shipment in the continuous move tour.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• cmPrevDestLocation: cmPrevDestLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cmPrevDestLocationGid: string
  The destination location of the previous shipment in the continuous move tour.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• cmSequenceNum: number (int32)
  Read Only: true

  Indicates the shipment's sequence in the continuous move tour.
• cofcTofc: string
  The trailer or flat car or the container on flat car code for rail shipments.
• combinationEquipGrp: combinationEquipGrp
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• combinationEquipGrpGid: string
  The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments. This attribute is marked as Create-Only.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• consol: consol
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• consolGid: string
  The consol identifier if the shipment has been built from a consol structure.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  Read Only: true

  The contact identifier linking in the contact table information to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• containerDeliveryLoc: containerDeliveryLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• containerDeliveryLocGid: string
  The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• containerGroups: containerGroups
• containerPickupLoc: containerPickupLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• containerPickupLocGid: string
  The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• costs: costs
• currencyGid: string
  Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.
• currentStopNum: number (int32)
  Read Only: true

  The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.
• customerRateCode: string
  The customer rate identifier associated with the shipment if this shipment is planned using a customer.
• deliveringServprov: deliveringServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• deliveringServprovGid: string
  Read Only: true

  The service provider who is the delivering service provider for this shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• destArbLevelOfServiceGid: string
  The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.
• destLocation: destLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destLocationGid: string
  The GID of the destination location of the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• destLocationOverrideGid: string
  The location identifier that will override the destination location that is defined for the shipment.
• destPierLocation: destPierLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destPierLocationGid: string
  The destination operational location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dimVolume: dimVolume
  Read Only: true

  The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.
• dimWeight: dimWeight
  Read Only: true

  The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.
• documents: documents
• domainName: string
  The database domain where this data is stored.
• driver: driver
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• driverAssignBulkPlanGid: string
  Read Only: true

  Fleet bulk plan ID for driver assignment.
• driverGid: string
  The driver or primary team driver assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dropInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for dropping an empty equipment after freight.
• dutyPaid: string
  The duty paid of the shipment.
• earliestStartTime: earliestStartTime
  The earliest start time that will make this shipment feasible.
• emPhoneNumber: string
  The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.
• endTime: endTime
  The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.
• equipmentAssignBulkPlanGid: string
  Read Only: true

  Fleet bulk plan ID for equipment assignment.
• equipmentDestination: string
  equipment destination
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentDestinationRefObject: equipmentDestinationRefObject
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
  This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.
• equipmentReferenceUnitGid: string
  The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.
• equipRefUnitUtilization: number (double)
  The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.
• etaDate: etaDate
  Estimated time of arrival
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• externalVoyageCode: string
  Specifies the number of the voyage as assigned by the carrier that transports the shipment.
• feasibilityCodeGid: string
  Read Only: true

  The feasibility code associated with the shipment can identify shipment infeasibilities.
• firstEquipmentGroupGid: string
  Read Only: true

  A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.
• firstEquipmentInitial: string
  first equipment intial
• firstEquipmentNumber: string
  first equipment number
• fixedServiceDays: number (int32)
  The fixed number of service days, if returned by the rating engine.
• flightInstanceId: number (int64)
  The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.
• freightTerms: string
  The freight terms for the shipment, such as prepaid or collect.
• hasAppointments: boolean
  Indicates if any stops on the shipment have appointments.
• hazmatModeGid: string
  The hazmat mode identifier that is associated with the shipment.
• hazmatRegionGid: string
  The hazmat region identifier that is associated with the shipment.
• incoTermGid: string
  The Incoterm identifier associated with the shipment.
• informationalCosts: informationalCosts
• insertDate: insertDate
  Read Only: true

  insert date
• insuranceAmount: insuranceAmount
  The insurance amount of the shipment.
• insurancePolicyNumber: string
  The insurance policy number that covers this shipment, for informational purposes.
• insurancePremium: insurancePremium
  The insurance premium of the shipment, for informational purposes.
• intermediaryCorporation: intermediaryCorporation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• intermediaryCorporationGid: string
  The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• inTrailerBuild: boolean
  Read Only: true

  Indicates that this shipment is in a trailer build shipment group.
• involvedParties: involvedParties
• isAdvancedCharge: boolean
  A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.
• isArRouteCodeFixed: boolean
  This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.
• isAutoMergeConsolidate: boolean
  Read Only: true

  Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)
• isCostFixed: boolean
  A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.
• isCpctyOverrideApplicable: boolean
  A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.
• isCreditNote: boolean
  Y/N based on an associated credit note.
• isEquipmentFixed: boolean
  Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.
• isFixedDistance: boolean
  Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.
• isFixedTenderContact: boolean
  Read Only: true

  A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.
• isFixedVoyage: boolean
  A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.
• isHazardous: boolean
  A Y/N indicator specifying that the shipment is identified as having hazardous material.
• isMemoBl: boolean
  Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.
• isPermanent: boolean
  Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in "delete shipment" action.
• isPreferredCarrier: boolean
  Indicates if the carrier selected for the shipment is preferred.
• isPreload: boolean
  A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.
• isPrimary: boolean
  Indicates if the shipment is the primary shipment related to an order (bookings) path.
• isProfitSplit: boolean
  Indicates if the NFRC shipment will be profit split.
• isRateGeoFixed: boolean
  A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.
• isRateOfferingFixed: boolean
  A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.
• isRecalcTotals: boolean
  Turns on/off totaling logic.
• isServiceTimeFixed: boolean
  A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.
• isServprovFixed: boolean
  A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.
• isSpotCosted: boolean
  Read Only: true

  Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.
• isTemperatureControl: boolean
  A Y/N indicator specifying that the shipment is identified as needing temperature control.
• isTemplate: boolean
  Indicates whether a shipment is a template. This attribute is marked as Create-Only.
• isToBeHeld: boolean
  A Y/N indicator specifying that the shipment is to be held by the carrier.
• itinerary: itinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itineraryGid: string
  Read Only: true

  The itinerary identifier that was used to build the shipment if it was built with the planning logic.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• jobGid: string
  The job GID identifier of the shipment, if the shipment is assigned to a job.
• lastEventGroupGid: string
  Read Only: true

  The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.
• latestStartTime: latestStartTime
  The latest start time that will make this shipment feasible.
• links: array links
  Read Only: true
• loadConfigEngineTypeGid: string
  Null type means no load configuration is performed on the shipment.
• loadedDistance: loadedDistance
  The total distance that the truck or the transportation mode will travel when the shipment is loaded.
• loadingHallPenalty: number (double)
  The loading hall penalty used while building loading halls for the shipment.
• marketCost: marketCost
  Market cost based on the shipment.
• maxNumRetender: number (int32)
  Maximum number of re-tenders.
• nfrcRuleGid: string
  The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.
• numEquipmentOrdered: number (int32)
  The number of equipment ordered. This is manually set by the user and can be rated on.
• numOrderReleases: number (int32)
  The number of order releases that are on this shipment.
• numStops: number (int32)
  The number of shipment stop records related to this shipment.
• orderReleases: orderReleases
• originalInvoiceCost: originalInvoiceCost
  The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.
• originalShipmentGid: string
  If the shipment represents a secondary charge, this points back to the "parent" shipment for which the secondary shipment is a "child".
• originatingServprov: originatingServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• originatingServprovGid: string
  Read Only: true

  The service provider who is the originating service provider for this shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• parcelZone: string
  The ship to mail zone. A price key used for parcel rate calculations.
• parentLegGid: string
  Read Only: true

  The parent leg associated with the itinerary that may have been used to plan the shipment.
• paymentMethodCodeGid: string
  The payment method code identifier.
• perspective: string
  The indicates if the shipment is a buy or sell perspective.
• pickInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for picking an empty equipment before freight.
• placeDeliverLocation: placeDeliverLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• placeDeliverLocationGid: string
  The place deliver location identifier specifying the location where ownership of freight ends with delivery.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• placeReceiptLocation: placeReceiptLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• placeReceiptLocationGid: string
  The place receipt location identifier specifying the location where ownership of freight starts.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• plannedCo2Emission: plannedCo2Emission
  CO2 emissions recorded while planning the shipment.
• plannedCo2EqEmission: plannedCo2EqEmission
  CO2 equivalent emissions recorded while planning the shipment.
• plannedCost: plannedCost
  The cost when the original shipment was created. This attribute is marked as Create-Only.
• plannedRateGeoGid: string
  Read Only: true

  The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedRateOfferingGid: string
  Read Only: true

  The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedServprov: plannedServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• plannedServprovGid: string
  Read Only: true

  The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• plannedTransportModeGid: string
  Read Only: true

  The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• planningParameterSetGid: string
  Read Only: true

  The parameter set GID which is used in building this shipment.
• portDischargeEta: portDischargeEta
  The estimated port of discharge date associated with ocean-going shipments.
• portExitLoc: portExitLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portExitLocGid: string
  The designated port the freight will be exiting the country for international shipments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfDisLocation: portOfDisLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfDisLocationGid: string
  The location ID of the port of discharge for the primary leg carrier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfDisOverrideLocGid: string
  The location override ID of the port of discharge for the primary leg carrier.
• portOfExitDate: portOfExitDate
  The estimated port of exit (for international shipments) associated with ocean going shipments.
• portOfLoadLocation: portOfLoadLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfLoadLocationGid: string
  The location ID of the port of load for the primary leg carrier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfLoadOverrideLocGid: string
  The location override ID of the port of load for the primary leg carrier.
• powerUnit: powerUnit
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• powerUnitGid: string
  The power unit assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• prevDropInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for driver's previous shipment's equipment.
• prevEquipmentDestination: string
  previous equipment destination
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• prevEquipmentDestinationRefObject: prevEquipmentDestinationRefObject
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
  This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.
• prevReportedBsStatusCode: string
  previous reported event for shipment
• prevReportingScac: string
  previous reporting scac
• prevSightingDate: prevSightingDate
  Read Only: true

  The date associated with the previous sighting location and in the tracking event.
• prevSightingLocation: prevSightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• prevSightingLocationGid: string
  Read Only: true

  The location identifier for the previous sighting location used for rail shipment and tracking events.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• primaryOrderBase: primaryOrderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• primaryOrderBaseGid: string
  A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• processingCodeGid: string
  The processing code GID.
• projectedTourName: string
  Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.
• projectedTourSequenceNum: number (int32)
  Represents the sequence in which the shipment should appear in the projected tour.
• railDate: railDate
  The rail date of the shipment that is populated if the shipment utilizes the rail schedules.
• railInterModalPlanGid: string
  The rail intermodal plan identifier of the shipment used for intermodal rail shipments.
• railReturnLocation: railReturnLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• railReturnLocationGid: string
  The rail return location identifier of the rail shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• railReturnRouteGid: string
  The rail return route identifier of the rail shipment.
• rateGeoGid: string
  The detailed rate record (contract) identifier that is used by the service provider moving this shipment.
• rateOfferingGid: string
  The rate offering (contract) identifier that is used by the service provider moving this shipment.
• refnums: refnums
• remarks: remarks
• repetitionScheduleGid: string
  Read Only: true

  The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.
• reportedBsStatusCode: string
  latest reported event for shipment
• reportingScac: string
  reporting scac
• reqdocs: reqdocs
• reservationNum: string
  Saved here to search shipments based on Reservation Number.
• routeCodeCombinationGid: string
  Read Only: true

  The route code combination identifier of the shipment used for specifying rail shipments.
• rule11Indicator: string
  The rule 11 indicator of the shipment used for managing rail.
• rule7: boolean
  A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.
• sailCutoffDate: sailCutoffDate
  The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.
• sailDate: sailDate
  The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.
• scheduleType: string
  Read Only: true

  When the schedule type is populated, it is a consol.
• secondaryChargeRuleGid: string
  Read Only: true

  The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.
• secondaryDriver: secondaryDriver
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• secondaryDriverGid: string
  The secondary team driver assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sEquipments: sEquipments
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The service provider identifier associated with the shipment. This attribute is marked as Create-Only.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentAsWork: boolean
  Indicates the shipment as work. This attribute is marked as Create-Only.
• shipmentGid: string
  The GID for the shipment.
• shipmentGroup: shipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGroupGid: string
  The shipment group identifier if this shipment is placed into a single group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentName: string
  A descriptive name of the shipment.
• shipmentReleased: boolean
  A Y/N indicator used for rail shipments that indicate that the shipment is ready.
• shipmentTypeGid: string
  The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.
• shipmentXid: string
  The XID for the shipment.
• shippingAgentContactGid: string
  Indicate if this NFRC is created from the Assign Shipping Agent action on the job.
• siCutoffDate: siCutoffDate
  The shippers instruction cutoff date associated with the shipment.
• sightingDate: sightingDate
  Read Only: true

  The date and time when the shipment was last sighted at the sighting location.
• sightingLocation: sightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sightingLocationGid: string
  Read Only: true

  The location where the shipment was last sighted.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• solePackagedItem: solePackagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• solePackagedItemGid: string
  only one equipment and with only one item
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sourceLocation: sourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourceLocationGid: string
  The GID of the source location of the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sourceLocationOverrideGid: string
  The location identifier that will override the source location that is defined for the shipment.
• sourcePierLocation: sourcePierLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourcePierLocationGid: string
  The source operational location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• specialServices: specialServices
• srcArbLevelOfServiceGid: string
  The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.
• startTime: startTime
  The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.
• statuses: statuses
• stops: stops
• tariffDate: tariffDate
  The tariff date, for informational purposes.
• tariffName: string
  The tariff name, for informational purposes.
• tariffNumber: string
  The tariff number, for informational purposes.
• tariffOrganizationName: string
  The tariff organization name, for informational purposes.
• tariffOrganizationNumber: string
  The tariff organization number, for informational purposes.
• termLocationText: string
  The term location text that is informational for the shipment.
• texts: texts
• totalActualCost: totalActualCost
  The total actual cost of the shipment. This attribute is marked as Create-Only.
• totalApprovedCost: totalApprovedCost
  The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.
• totalDeclaredValue: totalDeclaredValue
  The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.
• totalItemPackageCount: number (int32)
  Read Only: true

  The total item package count of the shipment.
• totalNetVolume: totalNetVolume
  The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.
• totalNetWeight: totalNetWeight
  The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.
• totalNumReferenceUnits: number (double)
  Read Only: true

  The total number of reference units of the shipment as defined by the equipment reference units.
• totalPackagingUnitCount: number (int32)
  Read Only: true

  The total packaging unit count of the shipment.
• totalShipUnitCount: number (int64)
  The total ship unit count of the shipment.
• totalTransCost: totalTransCost
  Read Only: true

  The total cost of the shipment. It represents the total transportation cost after applying the rebate.
• totalVolume: totalVolume
  The total volume of the shipment.
• totalWeight: totalWeight
  The total weight of the shipment.
• totalWeightedCost: totalWeightedCost
  The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative. This attribute is marked as Create-Only.
• totMatchedInvoiceCost: totMatchedInvoiceCost
  The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment. This attribute is marked as Create-Only.
• transportModeGid: string
  A unique identifier to define the transportation modes.
• unloadedDistance: unloadedDistance
  The total distance that the truck or the transportation mode will travel when empty.
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• vesselGid: string
  The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.
• volumeUtilization: number (double)
  The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.
• voyageGid: string
  The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.
• waybillDate: waybillDate
  Waybill date represents contractual agreement of the carriage.
• weighCode: string
  The weigh code of the shipment that identifies the weight type.
• weightUtilization: number (double)
  The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.
• workAssignmentBulkPlanGid: string
  Work assignment bulk plan ID which is generated during work assignment bulk plan process.
• workAssignmentGid: string
  The ID of the Work Assignment of which the shipment is part of.

{
    "properties":{
        "shipmentGid":{
            "description":"The GID for the shipment.",
            "type":"string"
        },
        "shipmentXid":{
            "description":"The XID for the shipment.",
            "type":"string"
        },
        "shipmentName":{
            "description":"A descriptive name of the shipment.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"A unique identifier to define the transportation modes.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Indicates whether a shipment is a template. This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "isPrimary":{
            "description":"Indicates if the shipment is the primary shipment related to an order (bookings) path.",
            "type":"boolean"
        },
        "isSpotCosted":{
            "description":"Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.",
            "type":"boolean",
            "readOnly":true
        },
        "isCreditNote":{
            "description":"Y/N based on an associated credit note.",
            "type":"boolean"
        },
        "cmPrevDestLocationGid":{
            "description":"The destination location of the previous shipment in the continuous move tour. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cmPrevDestLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "cmNextSourceLocationGid":{
            "description":"The source location of the next shipment in the continuous move tour. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cmNextSourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "totalActualCost":{
            "description":"The total actual cost of the shipment. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalTransCost":{
            "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ],
            "readOnly":true
        },
        "loadedDistance":{
            "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unloadedDistance":{
            "description":"The total distance that the truck or the transportation mode will travel when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID of the source location of the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destLocationGid":{
            "description":"The GID of the destination location of the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "startTime":{
            "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "freightTerms":{
            "description":"The freight terms for the shipment, such as prepaid or collect.",
            "type":"string"
        },
        "parentLegGid":{
            "description":"The parent leg associated with the itinerary that may have been used to plan the shipment.",
            "type":"string",
            "readOnly":true
        },
        "voyageGid":{
            "description":"The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The service provider identifier associated with the shipment. This attribute is marked as Create-Only. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "rateOfferingGid":{
            "description":"The rate offering (contract) identifier that is used by the service provider moving this shipment.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The detailed rate record (contract) identifier that is used by the service provider moving this shipment.",
            "type":"string"
        },
        "originalShipmentGid":{
            "description":"If the shipment represents a secondary charge, this points back to the \"parent\" shipment for which the secondary shipment is a \"child\".",
            "type":"string"
        },
        "shipmentGroupGid":{
            "description":"The shipment group identifier if this shipment is placed into a single group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "isAutoMergeConsolidate":{
            "description":"Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)",
            "type":"boolean",
            "readOnly":true
        },
        "perspective":{
            "description":"The indicates if the shipment is a buy or sell perspective.",
            "type":"string"
        },
        "flightInstanceId":{
            "description":"The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.",
            "type":"number",
            "format":"int64"
        },
        "totalWeight":{
            "description":"The total weight of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"The total volume of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalShipUnitCount":{
            "description":"The total ship unit count of the shipment.",
            "type":"number",
            "format":"int64"
        },
        "totalPackagingUnitCount":{
            "description":"The total packaging unit count of the shipment.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "totalItemPackageCount":{
            "description":"The total item package count of the shipment.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "intermediaryCorporationGid":{
            "description":"The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "intermediaryCorporation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/corporations"
                }
            ],
            "readOnly":true
        },
        "shipmentTypeGid":{
            "description":"The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.",
            "type":"string"
        },
        "routeCodeCombinationGid":{
            "description":"The route code combination identifier of the shipment used for specifying rail shipments.",
            "type":"string",
            "readOnly":true
        },
        "railInterModalPlanGid":{
            "description":"The rail intermodal plan identifier of the shipment used for intermodal rail shipments.",
            "type":"string"
        },
        "customerRateCode":{
            "description":"The customer rate identifier associated with the shipment if this shipment is planned using a customer.",
            "type":"string"
        },
        "cofcTofc":{
            "description":"The trailer or flat car or the container on flat car code for rail shipments.",
            "type":"string"
        },
        "railReturnLocationGid":{
            "description":"The rail return location identifier of the rail shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "railReturnLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "railReturnRouteGid":{
            "description":"The rail return route identifier of the rail shipment.",
            "type":"string"
        },
        "rule11Indicator":{
            "description":"The rule 11 indicator of the shipment used for managing rail.",
            "type":"string"
        },
        "currentStopNum":{
            "description":"The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "shipmentAsWork":{
            "description":"Indicates the shipment as work. This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "secondaryChargeRuleGid":{
            "description":"The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.",
            "type":"string",
            "readOnly":true
        },
        "checkTimeConstraint":{
            "description":"The indicator to check the time constraints associated with the shipment.",
            "type":"boolean"
        },
        "checkCostConstraint":{
            "description":"The indicator to check cost constraints associated with the shipment",
            "type":"boolean"
        },
        "checkCapacityConstraint":{
            "description":"The indicator to check the capacity constraints associated with the shipment.",
            "type":"boolean"
        },
        "cmName":{
            "description":"The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.",
            "type":"string",
            "readOnly":true
        },
        "cmSequenceNum":{
            "description":"Indicates the shipment's sequence in the continuous move tour.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "cmCost":{
            "description":"The shipment cost when the shipment is part of a continuous move tour.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "cmEmptyDistance":{
            "description":"The empty leg distance between previous and this shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazmatModeGid":{
            "description":"The hazmat mode identifier that is associated with the shipment.",
            "type":"string"
        },
        "hazmatRegionGid":{
            "description":"The hazmat region identifier that is associated with the shipment.",
            "type":"string"
        },
        "weighCode":{
            "description":"The weigh code of the shipment that identifies the weight type.",
            "type":"string"
        },
        "rule7":{
            "description":"A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.",
            "type":"boolean"
        },
        "shipmentReleased":{
            "description":"A Y/N indicator used for rail shipments that indicate that the shipment is ready.",
            "type":"boolean"
        },
        "processingCodeGid":{
            "description":"The processing code GID.",
            "type":"string"
        },
        "airRailRouteCode":{
            "description":"A transportation mode code that is informational for the shipment.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method code identifier.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The Incoterm identifier associated with the shipment.",
            "type":"string"
        },
        "dimWeight":{
            "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "plannedCost":{
            "description":"The cost when the original shipment was created. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "termLocationText":{
            "description":"The term location text that is informational for the shipment.",
            "type":"string"
        },
        "tariffOrganizationNumber":{
            "description":"The tariff organization number, for informational purposes.",
            "type":"string"
        },
        "tariffOrganizationName":{
            "description":"The tariff organization name, for informational purposes.",
            "type":"string"
        },
        "tariffName":{
            "description":"The tariff name, for informational purposes.",
            "type":"string"
        },
        "tariffNumber":{
            "description":"The tariff number, for informational purposes.",
            "type":"string"
        },
        "tariffDate":{
            "description":"The tariff date, for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "isHazardous":{
            "description":"A Y/N indicator specifying that the shipment is identified as having hazardous material.",
            "type":"boolean"
        },
        "isTemperatureControl":{
            "description":"A Y/N indicator specifying that the shipment is identified as needing temperature control.",
            "type":"boolean"
        },
        "isCostFixed":{
            "description":"A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.",
            "type":"boolean"
        },
        "isServiceTimeFixed":{
            "description":"A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.",
            "type":"boolean"
        },
        "isRateGeoFixed":{
            "description":"A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.",
            "type":"boolean"
        },
        "isRateOfferingFixed":{
            "description":"A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isServprovFixed":{
            "description":"A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isPreload":{
            "description":"A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.",
            "type":"boolean"
        },
        "isFixedTenderContact":{
            "description":"A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.",
            "type":"boolean",
            "readOnly":true
        },
        "isToBeHeld":{
            "description":"A Y/N indicator specifying that the shipment is to be held by the carrier.",
            "type":"boolean"
        },
        "isPreferredCarrier":{
            "description":"Indicates if the carrier selected for the shipment is preferred.",
            "type":"boolean"
        },
        "isEquipmentFixed":{
            "description":"Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.",
            "type":"boolean"
        },
        "isRecalcTotals":{
            "description":"Turns on/off totaling logic.",
            "type":"boolean"
        },
        "hasAppointments":{
            "description":"Indicates if any stops on the shipment have appointments.",
            "type":"boolean"
        },
        "contactGid":{
            "description":"The contact identifier linking in the contact table information to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "bulkPlanGid":{
            "description":"If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.",
            "type":"string",
            "readOnly":true
        },
        "totalNumReferenceUnits":{
            "description":"The total number of reference units of the shipment as defined by the equipment reference units.",
            "type":"number",
            "format":"double",
            "readOnly":true
        },
        "itineraryGid":{
            "description":"The itinerary identifier that was used to build the shipment if it was built with the planning logic. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "itinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "feasibilityCodeGid":{
            "description":"The feasibility code associated with the shipment can identify shipment infeasibilities.",
            "type":"string",
            "readOnly":true
        },
        "numOrderReleases":{
            "description":"The number of order releases that are on this shipment.",
            "type":"number",
            "format":"int32"
        },
        "numStops":{
            "description":"The number of shipment stop records related to this shipment.",
            "type":"number",
            "format":"int32"
        },
        "totalNetWeight":{
            "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalNetVolume":{
            "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "earliestStartTime":{
            "description":"The earliest start time that will make this shipment feasible.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latestStartTime":{
            "description":"The latest start time that will make this shipment feasible.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastEventGroupGid":{
            "description":"The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.",
            "type":"string",
            "readOnly":true
        },
        "repetitionScheduleGid":{
            "description":"The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.",
            "type":"string",
            "readOnly":true
        },
        "inTrailerBuild":{
            "description":"Indicates that this shipment is in a trailer build shipment group.",
            "type":"boolean",
            "readOnly":true
        },
        "firstEquipmentGroupGid":{
            "description":"A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.",
            "type":"string",
            "readOnly":true
        },
        "bulkCmGid":{
            "description":"The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.",
            "type":"string"
        },
        "vesselGid":{
            "description":"The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "sourceLocationOverrideGid":{
            "description":"The location identifier that will override the source location that is defined for the shipment.",
            "type":"string"
        },
        "destLocationOverrideGid":{
            "description":"The location identifier that will override the destination location that is defined for the shipment.",
            "type":"string"
        },
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.",
            "type":"string"
        },
        "scheduleType":{
            "description":"When the schedule type is populated, it is a consol.",
            "type":"string",
            "readOnly":true
        },
        "weightUtilization":{
            "description":"The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "volumeUtilization":{
            "description":"The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "equipRefUnitUtilization":{
            "description":"The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "jobGid":{
            "description":"The job GID identifier of the shipment, if the shipment is assigned to a job.",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"The location ID of the port of load for the primary leg carrier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfLoadLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfLoadOverrideLocGid":{
            "description":"The location override ID of the port of load for the primary leg carrier.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"The location ID of the port of discharge for the primary leg carrier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfDisLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfDisOverrideLocGid":{
            "description":"The location override ID of the port of discharge for the primary leg carrier.",
            "type":"string"
        },
        "insurancePolicyNumber":{
            "description":"The insurance policy number that covers this shipment, for informational purposes.",
            "type":"string"
        },
        "insuranceAmount":{
            "description":"The insurance amount of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "insurancePremium":{
            "description":"The insurance premium of the shipment, for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "bolType":{
            "description":"The bill of lading type defined for the shipment, used for report management.",
            "type":"string"
        },
        "bolIssuanceType":{
            "description":"The bill of lading issuance type identifier.",
            "type":"string"
        },
        "consolGid":{
            "description":"The consol identifier if the shipment has been built from a consol structure. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "consol":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/consols"
                }
            ],
            "readOnly":true
        },
        "placeReceiptLocationGid":{
            "description":"The place receipt location identifier specifying the location where ownership of freight starts. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "placeReceiptLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "placeDeliverLocationGid":{
            "description":"The place deliver location identifier specifying the location where ownership of freight ends with delivery. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "placeDeliverLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sailDate":{
            "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "railDate":{
            "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sailCutoffDate":{
            "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portDischargeEta":{
            "description":"The estimated port of discharge date associated with ocean-going shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portOfExitDate":{
            "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portExitLocGid":{
            "description":"The designated port the freight will be exiting the country for international shipments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portExitLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "containerDeliveryLocGid":{
            "description":"The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "containerDeliveryLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "containerPickupLocGid":{
            "description":"The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "containerPickupLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "nfrcRuleGid":{
            "description":"The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.",
            "type":"string"
        },
        "isCpctyOverrideApplicable":{
            "description":"A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.",
            "type":"boolean"
        },
        "plannedRateOfferingGid":{
            "description":"The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string",
            "readOnly":true
        },
        "plannedTransportModeGid":{
            "description":"The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string",
            "readOnly":true
        },
        "plannedServprovGid":{
            "description":"The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "plannedServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "plannedRateGeoGid":{
            "description":"The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string",
            "readOnly":true
        },
        "isPermanent":{
            "description":"Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in \"delete shipment\" action.",
            "type":"boolean"
        },
        "isMemoBl":{
            "description":"Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.",
            "type":"boolean"
        },
        "dutyPaid":{
            "description":"The duty paid of the shipment.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "currencyGid":{
            "description":"Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.",
            "type":"string"
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "totMatchedInvoiceCost":{
            "description":"The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "originalInvoiceCost":{
            "description":"The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalApprovedCost":{
            "description":"The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "sourcePierLocationGid":{
            "description":"The source operational location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourcePierLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destPierLocationGid":{
            "description":"The destination operational location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destPierLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "primaryOrderBaseGid":{
            "description":"A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "primaryOrderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "totalDeclaredValue":{
            "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isProfitSplit":{
            "description":"Indicates if the NFRC shipment will be profit split.",
            "type":"boolean"
        },
        "shippingAgentContactGid":{
            "description":"Indicate if this NFRC is created from the Assign Shipping Agent action on the job.",
            "type":"string"
        },
        "isAdvancedCharge":{
            "description":"A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.",
            "type":"boolean"
        },
        "loadConfigEngineTypeGid":{
            "description":"Null type means no load configuration is performed on the shipment.",
            "type":"string"
        },
        "appointmentPriorityGid":{
            "description":"The appointment priority identifier associated with the shipment.",
            "type":"string"
        },
        "isFixedDistance":{
            "description":"Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.",
            "type":"boolean"
        },
        "deliveringServprovGid":{
            "description":"The service provider who is the delivering service provider for this shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "deliveringServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "originatingServprovGid":{
            "description":"The service provider who is the originating service provider for this shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "originatingServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "chargeableWeight":{
            "description":"The dimensional weight as determined by the rating process.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "fixedServiceDays":{
            "description":"The fixed number of service days, if returned by the rating engine.",
            "type":"number",
            "format":"int32"
        },
        "sightingLocationGid":{
            "description":"The location where the shipment was last sighted. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "sightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sightingDate":{
            "description":"The date and time when the shipment was last sighted at the sighting location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "prevSightingLocationGid":{
            "description":"The location identifier for the previous sighting location used for rail shipment and tracking events. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "prevSightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevSightingDate":{
            "description":"The date associated with the previous sighting location and in the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "driverGid":{
            "description":"The driver or primary team driver assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "driver":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/drivers"
                }
            ],
            "readOnly":true
        },
        "secondaryDriverGid":{
            "description":"The secondary team driver assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "secondaryDriver":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/drivers"
                }
            ],
            "readOnly":true
        },
        "powerUnitGid":{
            "description":"The power unit assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "powerUnit":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/powerUnits"
                }
            ],
            "readOnly":true
        },
        "driverAssignBulkPlanGid":{
            "description":"Fleet bulk plan ID for driver assignment.",
            "type":"string",
            "readOnly":true
        },
        "equipmentAssignBulkPlanGid":{
            "description":"Fleet bulk plan ID for equipment assignment.",
            "type":"string",
            "readOnly":true
        },
        "prevDropInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for driver's previous shipment's equipment.",
            "type":"boolean"
        },
        "pickInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for picking an empty equipment before freight.",
            "type":"boolean"
        },
        "dropInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for dropping an empty equipment after freight.",
            "type":"boolean"
        },
        "dimVolume":{
            "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "chargeableVolume":{
            "description":"The actual volume used in calculating the cost of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"The database domain where this data is stored.",
            "type":"string"
        },
        "planningParameterSetGid":{
            "description":"The parameter set GID which is used in building this shipment.",
            "type":"string",
            "readOnly":true
        },
        "numEquipmentOrdered":{
            "description":"The number of equipment ordered. This is manually set by the user and can be rated on.",
            "type":"number",
            "format":"int32"
        },
        "emPhoneNumber":{
            "description":"The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.",
            "type":"string"
        },
        "parcelZone":{
            "description":"The ship to mail zone. A price key used for parcel rate calculations.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "combinationEquipGrpGid":{
            "description":"The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments. This attribute is marked as Create-Only. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "combinationEquipGrp":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "siCutoffDate":{
            "description":"The shippers instruction cutoff date associated with the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "cfsCutoffDate":{
            "description":"The container freight station cutoff date associated with the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "srcArbLevelOfServiceGid":{
            "description":"The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.",
            "type":"string"
        },
        "destArbLevelOfServiceGid":{
            "description":"The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.",
            "type":"string"
        },
        "cfsLocationGid":{
            "description":"The location identifier for the container freight station. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cfsLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "isFixedVoyage":{
            "description":"A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.",
            "type":"boolean"
        },
        "workAssignmentBulkPlanGid":{
            "description":"Work assignment bulk plan ID which is generated during work assignment bulk plan process.",
            "type":"string"
        },
        "aheadLateTime":{
            "description":"shipment status",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aheadOrLate":{
            "description":"A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user.  B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed  ",
            "type":"string"
        },
        "etaDate":{
            "description":"Estimated time of arrival",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "firstEquipmentInitial":{
            "description":"first equipment intial",
            "type":"string"
        },
        "firstEquipmentNumber":{
            "description":"first equipment number",
            "type":"string"
        },
        "solePackagedItemGid":{
            "description":"only one equipment and with only one item \t <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "solePackagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "reportedBsStatusCode":{
            "description":"latest reported event for shipment",
            "type":"string"
        },
        "reportingScac":{
            "description":"reporting scac",
            "type":"string"
        },
        "equipmentDestination":{
            "description":"equipment destination <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentDestinationRefObject":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevReportedBsStatusCode":{
            "description":"previous reported event for shipment",
            "type":"string"
        },
        "prevReportingScac":{
            "description":"previous reporting scac",
            "type":"string"
        },
        "prevEquipmentDestination":{
            "description":"previous equipment destination <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "prevEquipmentDestinationRefObject":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "maxNumRetender":{
            "description":"Maximum number of re-tenders.",
            "type":"number",
            "format":"int32"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "reservationNum":{
            "description":"Saved here to search shipments based on Reservation Number.",
            "type":"string"
        },
        "isArRouteCodeFixed":{
            "description":"This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.",
            "type":"boolean"
        },
        "waybillDate":{
            "description":"Waybill date represents contractual agreement of the carriage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "projectedTourName":{
            "description":"Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.",
            "type":"string"
        },
        "projectedTourSequenceNum":{
            "description":"Represents the sequence in which the shipment should appear in the projected tour.",
            "type":"number",
            "format":"int32"
        },
        "externalVoyageCode":{
            "description":"Specifies the number of the voyage as assigned by the carrier that transports the shipment.",
            "type":"string"
        },
        "plannedCo2Emission":{
            "description":"CO2 emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2Emission":{
            "description":"Actual CO2 emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "plannedCo2EqEmission":{
            "description":"CO2 equivalent emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2EqEmission":{
            "description":"Actual CO2 equivalent emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "marketCost":{
            "description":"Market cost based on the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "loadingHallPenalty":{
            "description":"The loading hall penalty used while building loading halls for the shipment.",
            "type":"number",
            "format":"double"
        },
        "workAssignmentGid":{
            "description":"The ID of the Work Assignment of which the shipment is part of.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "informationalCosts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.informationalCosts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderReleases":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.orderReleases"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "containerGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.containerGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reqdocs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.reqdocs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "sEquipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.sEquipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "stops":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "allocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.allocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCo2Emission

Actual CO2 emissions for the shipment.

Match All

Actual CO2 emissions for the shipment.

Show Source

• object amountType

{
    "description":"Actual CO2 emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualCo2EqEmission

Actual CO2 equivalent emissions for the shipment.

Match All

Actual CO2 equivalent emissions for the shipment.

Show Source

• object amountType

{
    "description":"Actual CO2 equivalent emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : aheadLateTime

shipment status

Match All

shipment status

Show Source

• object amountType

{
    "description":"shipment status",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : allocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.allocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cfsCutoffDate

The container freight station cutoff date associated with the shipment.

Match All

The container freight station cutoff date associated with the shipment.

Show Source

• object dateTimeType

{
    "description":"The container freight station cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cfsLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : chargeableVolume

Read Only: true

The actual volume used in calculating the cost of the shipment.

Match All

The actual volume used in calculating the cost of the shipment.

Show Source

• object amountType

{
    "description":"The actual volume used in calculating the cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : chargeableWeight

Read Only: true

The dimensional weight as determined by the rating process.

Match All

The dimensional weight as determined by the rating process.

Show Source

• object amountType

{
    "description":"The dimensional weight as determined by the rating process.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : cmCost

The shipment cost when the shipment is part of a continuous move tour.

Match All

The shipment cost when the shipment is part of a continuous move tour.

Show Source

• object currencyType

{
    "description":"The shipment cost when the shipment is part of a continuous move tour.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : cmEmptyDistance

The empty leg distance between previous and this shipments.

Match All

The empty leg distance between previous and this shipments.

Show Source

• object amountType

{
    "description":"The empty leg distance between previous and this shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : cmNextSourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : cmPrevDestLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : combinationEquipGrp

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : consol

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/consols"
        }
    ],
    "readOnly":true
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : containerDeliveryLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : containerGroups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.containerGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : containerPickupLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : costs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : deliveringServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : destLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : destPierLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : dimVolume

Read Only: true

The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.

Match All

The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.

Show Source

• object amountType

{
    "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : dimWeight

Read Only: true

The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.

Match All

The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.

Show Source

• object amountType

{
    "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : driver

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object drivers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/drivers"
        }
    ],
    "readOnly":true
}

Nested Schema : earliestStartTime

The earliest start time that will make this shipment feasible.

Match All

The earliest start time that will make this shipment feasible.

Show Source

• object dateTimeType

{
    "description":"The earliest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : endTime

The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Match All

The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Show Source

• object dateTimeType

{
    "description":"The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentDestinationRefObject

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : etaDate

Estimated time of arrival

Match All

Estimated time of arrival

Show Source

• object dateTimeType

{
    "description":"Estimated time of arrival",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : informationalCosts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.informationalCosts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : insuranceAmount

The insurance amount of the shipment.

Match All

The insurance amount of the shipment.

Show Source

• object currencyType

{
    "description":"The insurance amount of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : insurancePremium

The insurance premium of the shipment, for informational purposes.

Match All

The insurance premium of the shipment, for informational purposes.

Show Source

• object currencyType

{
    "description":"The insurance premium of the shipment, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : intermediaryCorporation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/corporations"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : itinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : latestStartTime

The latest start time that will make this shipment feasible.

Match All

The latest start time that will make this shipment feasible.

Show Source

• object dateTimeType

{
    "description":"The latest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : loadedDistance

The total distance that the truck or the transportation mode will travel when the shipment is loaded.

Match All

The total distance that the truck or the transportation mode will travel when the shipment is loaded.

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : marketCost

Market cost based on the shipment.

Match All

Market cost based on the shipment.

Show Source

• object currencyType

{
    "description":"Market cost based on the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : orderReleases

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.orderReleases"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : originalInvoiceCost

The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.

Match All

The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.

Show Source

• object currencyType

{
    "description":"The original invoice cost at the point when the invoice was initially created or matched to the shipment. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : originatingServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : placeDeliverLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : placeReceiptLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : plannedCo2Emission

CO2 emissions recorded while planning the shipment.

Match All

CO2 emissions recorded while planning the shipment.

Show Source

• object amountType

{
    "description":"CO2 emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCo2EqEmission

CO2 equivalent emissions recorded while planning the shipment.

Match All

CO2 equivalent emissions recorded while planning the shipment.

Show Source

• object amountType

{
    "description":"CO2 equivalent emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCost

The cost when the original shipment was created. This attribute is marked as Create-Only.

Match All

The cost when the original shipment was created. This attribute is marked as Create-Only.

Show Source

• object currencyType

{
    "description":"The cost when the original shipment was created. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : plannedServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : portDischargeEta

The estimated port of discharge date associated with ocean-going shipments.

Match All

The estimated port of discharge date associated with ocean-going shipments.

Show Source

• object dateTimeType

{
    "description":"The estimated port of discharge date associated with ocean-going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : portExitLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfDisLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfExitDate

The estimated port of exit (for international shipments) associated with ocean going shipments.

Match All

The estimated port of exit (for international shipments) associated with ocean going shipments.

Show Source

• object dateTimeType

{
    "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : portOfLoadLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : powerUnit

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/powerUnits"
        }
    ],
    "readOnly":true
}

Nested Schema : prevEquipmentDestinationRefObject

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingDate

Read Only: true

The date associated with the previous sighting location and in the tracking event.

Match All

The date associated with the previous sighting location and in the tracking event.

Show Source

• object dateTimeType

{
    "description":"The date associated with the previous sighting location and in the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : primaryOrderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : railDate

The rail date of the shipment that is populated if the shipment utilizes the rail schedules.

Match All

The rail date of the shipment that is populated if the shipment utilizes the rail schedules.

Show Source

• object dateTimeType

{
    "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : railReturnLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reqdocs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.reqdocs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sailCutoffDate

The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.

Match All

The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.

Show Source

• object dateTimeType

{
    "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sailDate

The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.

Match All

The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.

Show Source

• object dateTimeType

{
    "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : secondaryDriver

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object drivers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/drivers"
        }
    ],
    "readOnly":true
}

Nested Schema : sEquipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.sEquipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : shipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : siCutoffDate

The shippers instruction cutoff date associated with the shipment.

Match All

The shippers instruction cutoff date associated with the shipment.

Show Source

• object dateTimeType

{
    "description":"The shippers instruction cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingDate

Read Only: true

The date and time when the shipment was last sighted at the sighting location.

Match All

The date and time when the shipment was last sighted at the sighting location.

Show Source

• object dateTimeType

{
    "description":"The date and time when the shipment was last sighted at the sighting location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : sightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : solePackagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : sourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : sourcePierLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : startTime

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Match All

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Show Source

• object dateTimeType

{
    "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stops

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tariffDate

The tariff date, for informational purposes.

Match All

The tariff date, for informational purposes.

Show Source

• object dateType

{
    "description":"The tariff date, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalActualCost

The total actual cost of the shipment. This attribute is marked as Create-Only.

Match All

The total actual cost of the shipment. This attribute is marked as Create-Only.

Show Source

• object currencyType

{
    "description":"The total actual cost of the shipment. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalApprovedCost

The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.

Match All

The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.

Show Source

• object currencyType

{
    "description":"The total approved cost associated with the shipment after the approval step in the freight payment process. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalDeclaredValue

The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.

Match All

The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.

Show Source

• object currencyType

{
    "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalNetVolume

The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.

Match All

The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.

Show Source

• object amountType

{
    "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalNetWeight

The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.

Match All

The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.

Show Source

• object amountType

{
    "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalTransCost

Read Only: true

The total cost of the shipment. It represents the total transportation cost after applying the rebate.

Match All

The total cost of the shipment. It represents the total transportation cost after applying the rebate.

Show Source

• object currencyType

{
    "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ],
    "readOnly":true
}

Nested Schema : totalVolume

The total volume of the shipment.

Match All

The total volume of the shipment.

Show Source

• object amountType

{
    "description":"The total volume of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

The total weight of the shipment.

Match All

The total weight of the shipment.

Show Source

• object amountType

{
    "description":"The total weight of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeightedCost

The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative. This attribute is marked as Create-Only.

Match All

The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative. This attribute is marked as Create-Only.

Show Source

• object currencyType

{
    "description":"The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totMatchedInvoiceCost

The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment. This attribute is marked as Create-Only.

Match All

The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment. This attribute is marked as Create-Only.

Show Source

• object currencyType

{
    "description":"The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : unloadedDistance

The total distance that the truck or the transportation mode will travel when empty.

Match All

The total distance that the truck or the transportation mode will travel when empty.

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : waybillDate

Waybill date represents contractual agreement of the carriage.

Match All

Waybill date represents contractual agreement of the carriage.

Show Source

• object dateTimeType

{
    "description":"Waybill date represents contractual agreement of the carriage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  The XID for the shipment.
• adjustmentReasonGid: string
  The reason why the accessorial was added.
• costRefs: costRefs
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• processAsFlowThru: boolean
  The override for record to be copied to the sell side during rating.
• remarks: remarks

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The XID for the shipment.",
            "type":"string"
        },
        "processAsFlowThru":{
            "description":"The override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why the accessorial was added.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costRefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.accessorials.costRefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.accessorials.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costRefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.accessorials.costRefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.accessorials.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.accessorials.costRefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• costReferenceGid: string
  The cost reference GID.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentCostQualGid: string
  The shipment cost qualifier GID that defines the type of cost.

{
    "properties":{
        "costReferenceGid":{
            "description":"The cost reference GID.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The shipment cost qualifier GID that defines the type of cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.accessorials.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, which identifies the type of remark this is.
• remarkSequence: number (int64)
  The one-up sequence for the remark, to create a unique identifier.
• remarkText: string
  The remark itself.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up sequence for the remark, to create a unique identifier.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, which identifies the type of remark this is.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark itself.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.allocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• allocatedCost: allocatedCost
  No description.
• allocSeqNo: number (int64)
  No description.
• allocTypeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• invoice: invoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• invoiceGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• orderAllocations: orderAllocations
• orderBaseLineAllocations: orderBaseLineAllocations
• orderLineAllocations: orderLineAllocations
• parentInvoice: parentInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentInvoiceGid: string
  If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipGroup: shipGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipGroupGid: string
  Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
  group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• timestamp: timestamp
  No description.
• voucher: voucher
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voucherGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "invoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"If populated, the INVOICE_GID indicates that this alllocation is for a child invoice.  This column indicates the parent invoice of the entire consolidation that was allocated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "voucherGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voucher":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/vouchers"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "orderAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.allocations.orderAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderLineAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.allocations.orderLineAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderBaseLineAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.allocations.orderBaseLineAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : invoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.allocations.orderAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderBaseLineAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.allocations.orderBaseLineAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderLineAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.allocations.orderLineAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : parentInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : shipGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : timestamp

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : voucher

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object vouchers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/vouchers"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.allocations.orderAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release record.
• invoiceGid: string
  Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill
• lineitemSeqNo: number (int32)
  Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill
• links: array links
  Read Only: true
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based on shipment
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release record.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "lineitemSeqNo":{
            "description":"Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill",
            "type":"number",
            "format":"int32"
        },
        "invoiceGid":{
            "description":"Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill",
            "type":"string"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based on  shipment ",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.allocations.orderBaseLineAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  No description.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  No description.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• obLineGid: string
  No description.
• shipmentCostSeqno: number (int64)
  No description.
• shipmentGid: string
  No description.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  No description.

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "obLineGid":{
            "description":"No description.",
            "type":"string"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"No description.",
            "type":"string"
        },
        "voucherGid":{
            "description":"No description.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.allocations.orderLineAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release line record.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• orderReleaseLine: orderReleaseLine
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseLineGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based Shipment.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher or invoice

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseLineGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderReleaseLine":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleaseLines"
                }
            ],
            "readOnly":true
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release line record.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based Shipment.",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher or invoice",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderReleaseLine

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object orderReleaseLines

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleaseLines"
        }
    ],
    "readOnly":true
}

Nested Schema : vouchers

Type: object

Show Source

• adjustmentReasonGid: string
  The adjustment reason GID.
• allocations: allocations
• amountToPay: amountToPay
  The dollar amount to be paid for the voucher.
• amtToPayWithTax: amtToPayWithTax
  The Amount to Pay with Tax for the Voucher.
• approvedBy: string
  The name of the person who has approved payment for the voucher.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• documents: documents
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• insertDate: insertDate
  Read Only: true

  insert date
• invoice: invoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• invoiceGid: string
  The GID for the voucher.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• invoiceLines: invoiceLines
• links: array links
  Read Only: true
• refnums: refnums
• remarks: remarks
• shipments: shipments
• statuses: statuses
• timestamp: timestamp
  Time stamp for voucher.
• updateDate: updateDate
  Read Only: true

  update date
• vatAnalyses: vatAnalyses
• voucherGid: string
  The GID for the voucher.
• voucherNumber: string
  The number of the voucher.
• voucherXid: string
  The XID for the voucher.
• wasAutoApproved: boolean
  Contains a Y for yes if the voucher was automatically approved or an N for no if not.

{
    "properties":{
        "voucherGid":{
            "description":"The GID for the voucher.",
            "type":"string"
        },
        "voucherXid":{
            "description":"The XID for the voucher.",
            "type":"string"
        },
        "voucherNumber":{
            "description":"The number of the voucher.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"The GID for the voucher. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "invoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "wasAutoApproved":{
            "description":"Contains a Y for yes if the voucher was automatically approved or an N for no if not.",
            "type":"boolean"
        },
        "approvedBy":{
            "description":"The name of the person who has approved payment for the voucher.",
            "type":"string"
        },
        "amountToPay":{
            "description":"The dollar amount to be paid for the voucher.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "timestamp":{
            "description":"Time stamp for voucher.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "adjustmentReasonGid":{
            "description":"The adjustment reason GID.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "amtToPayWithTax":{
            "description":"The Amount to Pay with Tax for the Voucher.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vatAnalyses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.vatAnalyses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "invoiceLines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.invoiceLines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "allocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.allocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.shipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.allocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : amountToPay

The dollar amount to be paid for the voucher.

Match All

The dollar amount to be paid for the voucher.

Show Source

• object currencyType

{
    "description":"The dollar amount to be paid for the voucher.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : amtToPayWithTax

The Amount to Pay with Tax for the Voucher.

Match All

The Amount to Pay with Tax for the Voucher.

Show Source

• object currencyType

{
    "description":"The Amount to Pay with Tax for the Voucher.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : invoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : invoiceLines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.invoiceLines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : shipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.shipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : timestamp

Time stamp for voucher.

Match All

Time stamp for voucher.

Show Source

• object dateType

{
    "description":"Time stamp for voucher.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : vatAnalyses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.vatAnalyses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.allocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.allocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.allocations

Type: object

Show Source

• allocatedCost: allocatedCost
  No description.
• allocSeqNo: number (int64)
  No description.
• allocTypeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• invoice: invoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• invoiceGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• orderAllocations: orderAllocations
• orderBaseLineAllocations: orderBaseLineAllocations
• orderLineAllocations: orderLineAllocations
• parentInvoice: parentInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentInvoiceGid: string
  If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipGroup: shipGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipGroupGid: string
  Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
  group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• timestamp: timestamp
  No description.

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "invoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"If populated, the INVOICE_GID indicates that this alllocation is for a child invoice.  This column indicates the parent invoice of the entire consolidation that was allocated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "orderAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.allocations.orderAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderLineAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.allocations.orderLineAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "orderBaseLineAllocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.allocations.orderBaseLineAllocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : invoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.allocations.orderAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderBaseLineAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.allocations.orderBaseLineAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : orderLineAllocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.allocations.orderLineAllocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : parentInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : shipGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : timestamp

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.allocations.orderAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.allocations.orderAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.allocations.orderAllocations

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release record.
• invoiceGid: string
  Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill
• lineitemSeqNo: number (int32)
  Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill
• links: array links
  Read Only: true
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based on shipment
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release record.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "lineitemSeqNo":{
            "description":"Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill",
            "type":"number",
            "format":"int32"
        },
        "invoiceGid":{
            "description":"Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill",
            "type":"string"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based on  shipment ",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.allocations.orderBaseLineAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.allocations.orderBaseLineAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.allocations.orderBaseLineAllocations

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  No description.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  No description.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• obLineGid: string
  No description.
• shipmentCostSeqno: number (int64)
  No description.
• shipmentGid: string
  No description.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  No description.

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "obLineGid":{
            "description":"No description.",
            "type":"string"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"No description.",
            "type":"string"
        },
        "voucherGid":{
            "description":"No description.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.allocations.orderLineAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.allocations.orderLineAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.allocations.orderLineAllocations

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release line record.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• orderReleaseLine: orderReleaseLine
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseLineGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based Shipment.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher or invoice

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseLineGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderReleaseLine":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleaseLines"
                }
            ],
            "readOnly":true
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release line record.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based Shipment.",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher or invoice",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderReleaseLine

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object orderReleaseLines

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleaseLines"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.invoiceLines

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.invoiceLines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.invoiceLines

Type: object

Show Source

• adjustmentReasonGid: string
  The GID for the adjustment reason.
• amountPaid: amountPaid
  Amount paid.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• invoiceGid: string
  The GID for the invoice.
• lineitemSeqNo: number (int32)
  Line item sequence number for cost line item.
• links: array links
  Read Only: true

{
    "properties":{
        "invoiceGid":{
            "description":"The GID for the invoice.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"Line item sequence number for cost line item.",
            "type":"number",
            "format":"int32"
        },
        "amountPaid":{
            "description":"Amount paid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "adjustmentReasonGid":{
            "description":"The GID for the adjustment reason.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : amountPaid

Amount paid.

Match All

Amount paid.

Show Source

• object currencyType

{
    "description":"Amount paid.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• voucherRefnumQualGid: string
  The GID for the voucher reference number qualifier.
• voucherRefnumValue: string
  Value related to the reference number qualifier.

{
    "properties":{
        "voucherRefnumQualGid":{
            "description":"The GID for the voucher reference number qualifier.",
            "type":"string"
        },
        "voucherRefnumValue":{
            "description":"Value related to the reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  Remark qualifier.
• remarkSequence: number (int64)
  A sequence number for a remark on an voucher.
• remarkText: string
  The text for the remark on an voucher.

{
    "properties":{
        "remarkSequence":{
            "description":"A sequence number for a remark on an voucher.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"Remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text for the remark on an voucher.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.shipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.shipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.shipments

Type: object

Show Source

• actualCo2Emission: actualCo2Emission
  Actual CO2 emissions for the shipment.
• actualCo2EqEmission: actualCo2EqEmission
  Actual CO2 equivalent emissions for the shipment.
• aheadLateTime: aheadLateTime
  shipment status
• aheadOrLate: string
  A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user. B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed
• airRailRouteCode: string
  A transportation mode code that is informational for the shipment.
• appointmentPriorityGid: string
  The appointment priority identifier associated with the shipment.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeCurrency2: attributeCurrency2
  The attribute currency of the shipment.
• attributeCurrency3: attributeCurrency3
  The attribute currency of the shipment.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• bolIssuanceType: string
  The bill of lading issuance type identifier.
• bolType: string
  The bill of lading type defined for the shipment, used for report management.
• bulkCmGid: string
  The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.
• bulkPlanGid: string
  If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.
• cfsCutoffDate: cfsCutoffDate
  The container freight station cutoff date associated with the shipment.
• cfsLocation: cfsLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cfsLocationGid: string
  The location identifier for the container freight station.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• chargeableVolume: chargeableVolume
  The actual volume used in calculating the cost of the shipment.
• chargeableWeight: chargeableWeight
  The dimensional weight as determined by the rating process.
• checkCapacityConstraint: boolean
  The indicator to check the capacity constraints associated with the shipment.
• checkCostConstraint: boolean
  The indicator to check cost constraints associated with the shipment
• checkTimeConstraint: boolean
  The indicator to check the time constraints associated with the shipment.
• cmCost: cmCost
  The shipment cost when the shipment is part of a continuous move tour.
• cmEmptyDistance: cmEmptyDistance
  The empty leg distance between previous and this shipments.
• cmName: string
  The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.
• cmNextSourceLocation: cmNextSourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cmNextSourceLocationGid: string
  The source location of the next shipment in the continuous move tour.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• cmPrevDestLocation: cmPrevDestLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cmPrevDestLocationGid: string
  The destination location of the previous shipment in the continuous move tour.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• cmSequenceNum: number (int32)
  Indicates the shipment's sequence in the continuous move tour.
• cofcTofc: string
  The trailer or flat car or the container on flat car code for rail shipments.
• combinationEquipGrp: combinationEquipGrp
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• combinationEquipGrpGid: string
  The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• consol: consol
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• consolGid: string
  The consol identifier if the shipment has been built from a consol structure.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The contact identifier linking in the contact table information to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• containerDeliveryLoc: containerDeliveryLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• containerDeliveryLocGid: string
  The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• containerPickupLoc: containerPickupLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• containerPickupLocGid: string
  The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• currencyGid: string
  Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.
• currentStopNum: number (int32)
  The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.
• customerRateCode: string
  The customer rate identifier associated with the shipment if this shipment is planned using a customer.
• deliveringServprov: deliveringServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• deliveringServprovGid: string
  The service provider who is the delivering service provider for this shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• destArbLevelOfServiceGid: string
  The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.
• destLocation: destLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destLocationGid: string
  The GID of the destination location of the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• destLocationOverrideGid: string
  The location identifier that will override the destination location that is defined for the shipment.
• destPierLocation: destPierLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destPierLocationGid: string
  The destination operational location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dimVolume: dimVolume
  The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.
• dimWeight: dimWeight
  The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.
• domainName: string
  The database domain where this data is stored.
• driver: driver
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• driverAssignBulkPlanGid: string
  Fleet bulk plan ID for driver assignment.
• driverGid: string
  The driver or primary team driver assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dropInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for dropping an empty equipment after freight.
• dutyPaid: string
  The duty paid of the shipment.
• earliestStartTime: earliestStartTime
  The earliest start time that will make this shipment feasible.
• emPhoneNumber: string
  The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.
• endTime: endTime
  The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.
• equipmentAssignBulkPlanGid: string
  Fleet bulk plan ID for equipment assignment.
• equipmentDestination: string
  equipment destination
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentDestinationRefObject: equipmentDestinationRefObject
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
  This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.
• equipmentReferenceUnitGid: string
  The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.
• equipRefUnitUtilization: number (double)
  The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.
• etaDate: etaDate
  Estimated time of arrival
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• externalVoyageCode: string
  Specifies the number of the voyage as assigned by the carrier that transports the shipment.
• feasibilityCodeGid: string
  The feasibility code associated with the shipment can identify shipment infeasibilities.
• firstEquipmentGroupGid: string
  A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.
• firstEquipmentInitial: string
  first equipment intial
• firstEquipmentNumber: string
  first equipment number
• fixedServiceDays: number (int32)
  The fixed number of service days, if returned by the rating engine.
• flightInstanceId: number (int64)
  The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.
• freightTerms: string
  The freight terms for the shipment, such as prepaid or collect.
• hasAppointments: boolean
  Indicates if any stops on the shipment have appointments.
• hazmatModeGid: string
  The hazmat mode identifier that is associated with the shipment.
• hazmatRegionGid: string
  The hazmat region identifier that is associated with the shipment.
• incoTermGid: string
  The Incoterm identifier associated with the shipment.
• insuranceAmount: insuranceAmount
  The insurance amount of the shipment.
• insurancePolicyNumber: string
  The insurance policy number that covers this shipment, for informational purposes.
• insurancePremium: insurancePremium
  The insurance premium of the shipment, for informational purposes.
• intermediaryCorporation: intermediaryCorporation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• intermediaryCorporationGid: string
  The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• inTrailerBuild: boolean
  Indicates that this shipment is in a trailer build shipment group.
• isAdvancedCharge: boolean
  A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.
• isArRouteCodeFixed: boolean
  This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.
• isAutoMergeConsolidate: boolean
  Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)
• isCostFixed: boolean
  A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.
• isCpctyOverrideApplicable: boolean
  A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.
• isCreditNote: boolean
  Y/N based on an associated credit note.
• isEquipmentFixed: boolean
  Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.
• isFixedDistance: boolean
  Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.
• isFixedTenderContact: boolean
  A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.
• isFixedVoyage: boolean
  A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.
• isHazardous: boolean
  A Y/N indicator specifying that the shipment is identified as having hazardous material.
• isMemoBl: boolean
  Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.
• isPermanent: boolean
  Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in "delete shipment" action.
• isPreferredCarrier: boolean
  Indicates if the carrier selected for the shipment is preferred.
• isPreload: boolean
  A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.
• isPrimary: boolean
  Indicates if the shipment is the primary shipment related to an order (bookings) path.
• isProfitSplit: boolean
  Indicates if the NFRC shipment will be profit split.
• isRateGeoFixed: boolean
  A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.
• isRateOfferingFixed: boolean
  A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.
• isRecalcTotals: boolean
  Turns on/off totaling logic.
• isServiceTimeFixed: boolean
  A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.
• isServprovFixed: boolean
  A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.
• isSpotCosted: boolean
  Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.
• isTemperatureControl: boolean
  A Y/N indicator specifying that the shipment is identified as needing temperature control.
• isTemplate: boolean
  Indicates whether a shipment is a template.
• isToBeHeld: boolean
  A Y/N indicator specifying that the shipment is to be held by the carrier.
• itinerary: itinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itineraryGid: string
  The itinerary identifier that was used to build the shipment if it was built with the planning logic.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• jobGid: string
  The job GID identifier of the shipment, if the shipment is assigned to a job.
• lastEventGroupGid: string
  The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.
• latestStartTime: latestStartTime
  The latest start time that will make this shipment feasible.
• links: array links
  Read Only: true
• loadConfigEngineTypeGid: string
  Null type means no load configuration is performed on the shipment.
• loadedDistance: loadedDistance
  The total distance that the truck or the transportation mode will travel when the shipment is loaded.
• loadingHallPenalty: number (double)
  The loading hall penalty used while building loading halls for the shipment.
• marketCost: marketCost
  Market cost based on the shipment.
• maxNumRetender: number (int32)
  Maximum number of re-tenders.
• nfrcRuleGid: string
  The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.
• numEquipmentOrdered: number (int32)
  The number of equipment ordered. This is manually set by the user and can be rated on.
• numOrderReleases: number (int32)
  The number of order releases that are on this shipment.
• numStops: number (int32)
  The number of shipment stop records related to this shipment.
• originalInvoiceCost: originalInvoiceCost
  The original invoice cost at the point when the invoice was initially created or matched to the shipment.
• originalShipmentGid: string
  If the shipment represents a secondary charge, this points back to the "parent" shipment for which the secondary shipment is a "child".
• originatingServprov: originatingServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• originatingServprovGid: string
  The service provider who is the originating service provider for this shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• parcelZone: string
  The ship to mail zone. A price key used for parcel rate calculations.
• parentLegGid: string
  The parent leg associated with the itinerary that may have been used to plan the shipment.
• paymentMethodCodeGid: string
  The payment method code identifier.
• perspective: string
  The indicates if the shipment is a buy or sell perspective.
• pickInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for picking an empty equipment before freight.
• placeDeliverLocation: placeDeliverLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• placeDeliverLocationGid: string
  The place deliver location identifier specifying the location where ownership of freight ends with delivery.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• placeReceiptLocation: placeReceiptLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• placeReceiptLocationGid: string
  The place receipt location identifier specifying the location where ownership of freight starts.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• plannedCo2Emission: plannedCo2Emission
  CO2 emissions recorded while planning the shipment.
• plannedCo2EqEmission: plannedCo2EqEmission
  CO2 equivalent emissions recorded while planning the shipment.
• plannedCost: plannedCost
  The cost when the original shipment was created.
• plannedRateGeoGid: string
  The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedRateOfferingGid: string
  The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedServprov: plannedServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• plannedServprovGid: string
  The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• plannedTransportModeGid: string
  The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• planningParameterSetGid: string
  The parameter set GID which is used in building this shipment.
• portDischargeEta: portDischargeEta
  The estimated port of discharge date associated with ocean-going shipments.
• portExitLoc: portExitLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portExitLocGid: string
  The designated port the freight will be exiting the country for international shipments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfDisLocation: portOfDisLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfDisLocationGid: string
  The location ID of the port of discharge for the primary leg carrier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfDisOverrideLocGid: string
  The location override ID of the port of discharge for the primary leg carrier.
• portOfExitDate: portOfExitDate
  The estimated port of exit (for international shipments) associated with ocean going shipments.
• portOfLoadLocation: portOfLoadLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfLoadLocationGid: string
  The location ID of the port of load for the primary leg carrier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfLoadOverrideLocGid: string
  The location override ID of the port of load for the primary leg carrier.
• powerUnit: powerUnit
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• powerUnitGid: string
  The power unit assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• prevDropInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for driver's previous shipment's equipment.
• prevEquipmentDestination: string
  previous equipment destination
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• prevEquipmentDestinationRefObject: prevEquipmentDestinationRefObject
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
  This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.
• prevReportedBsStatusCode: string
  previous reported event for shipment
• prevReportingScac: string
  previous reporting scac
• prevSightingDate: prevSightingDate
  The date associated with the previous sighting location and in the tracking event.
• prevSightingLocation: prevSightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• prevSightingLocationGid: string
  The location identifier for the previous sighting location used for rail shipment and tracking events.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• primaryOrderBase: primaryOrderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• primaryOrderBaseGid: string
  A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• processingCodeGid: string
  The processing code GID.
• projectedTourName: string
  Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.
• projectedTourSequenceNum: number (int32)
  Represents the sequence in which the shipment should appear in the projected tour.
• railDate: railDate
  The rail date of the shipment that is populated if the shipment utilizes the rail schedules.
• railInterModalPlanGid: string
  The rail intermodal plan identifier of the shipment used for intermodal rail shipments.
• railReturnLocation: railReturnLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• railReturnLocationGid: string
  The rail return location identifier of the rail shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• railReturnRouteGid: string
  The rail return route identifier of the rail shipment.
• rateGeoGid: string
  The detailed rate record (contract) identifier that is used by the service provider moving this shipment.
• rateOfferingGid: string
  The rate offering (contract) identifier that is used by the service provider moving this shipment.
• refnums: refnums
• repetitionScheduleGid: string
  The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.
• reportedBsStatusCode: string
  latest reported event for shipment
• reportingScac: string
  reporting scac
• reservationNum: string
  Saved here to search shipments based on Reservation Number.
• routeCodeCombinationGid: string
  The route code combination identifier of the shipment used for specifying rail shipments.
• rule11Indicator: string
  The rule 11 indicator of the shipment used for managing rail.
• rule7: boolean
  A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.
• sailCutoffDate: sailCutoffDate
  The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.
• sailDate: sailDate
  The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.
• scheduleType: string
  When the schedule type is populated, it is a consol.
• secondaryChargeRuleGid: string
  The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.
• secondaryDriver: secondaryDriver
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• secondaryDriverGid: string
  The secondary team driver assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The service provider identifier associated with the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentAsWork: boolean
  Indicates the shipment as work.
• shipmentGid: string
  The GID for the shipment.
• shipmentGroup: shipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGroupGid: string
  The shipment group identifier if this shipment is placed into a single group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentName: string
  A descriptive name of the shipment.
• shipmentReleased: boolean
  A Y/N indicator used for rail shipments that indicate that the shipment is ready.
• shipmentTypeGid: string
  The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.
• shipmentXid: string
  The XID for the shipment.
• shippingAgentContactGid: string
  Indicate if this NFRC is created from the Assign Shipping Agent action on the job.
• siCutoffDate: siCutoffDate
  The shippers instruction cutoff date associated with the shipment.
• sightingDate: sightingDate
  The date and time when the shipment was last sighted at the sighting location.
• sightingLocation: sightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sightingLocationGid: string
  The location where the shipment was last sighted.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• solePackagedItem: solePackagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• solePackagedItemGid: string
  only one equipment and with only one item
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sourceLocation: sourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourceLocationGid: string
  The GID of the source location of the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sourceLocationOverrideGid: string
  The location identifier that will override the source location that is defined for the shipment.
• sourcePierLocation: sourcePierLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourcePierLocationGid: string
  The source operational location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• srcArbLevelOfServiceGid: string
  The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.
• startTime: startTime
  The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.
• tariffDate: tariffDate
  The tariff date, for informational purposes.
• tariffName: string
  The tariff name, for informational purposes.
• tariffNumber: string
  The tariff number, for informational purposes.
• tariffOrganizationName: string
  The tariff organization name, for informational purposes.
• tariffOrganizationNumber: string
  The tariff organization number, for informational purposes.
• termLocationText: string
  The term location text that is informational for the shipment.
• totalActualCost: totalActualCost
  The total actual cost of the shipment.
• totalApprovedCost: totalApprovedCost
  The total approved cost associated with the shipment after the approval step in the freight payment process.
• totalDeclaredValue: totalDeclaredValue
  The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.
• totalItemPackageCount: number (int32)
  The total item package count of the shipment.
• totalNetVolume: totalNetVolume
  The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.
• totalNetWeight: totalNetWeight
  The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.
• totalNumReferenceUnits: number (double)
  The total number of reference units of the shipment as defined by the equipment reference units.
• totalPackagingUnitCount: number (int32)
  The total packaging unit count of the shipment.
• totalShipUnitCount: number (int64)
  The total ship unit count of the shipment.
• totalTransCost: totalTransCost
  The total cost of the shipment. It represents the total transportation cost after applying the rebate.
• totalVolume: totalVolume
  The total volume of the shipment.
• totalWeight: totalWeight
  The total weight of the shipment.
• totalWeightedCost: totalWeightedCost
  The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.
• totMatchedInvoiceCost: totMatchedInvoiceCost
  The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.
• transportModeGid: string
  A unique identifier to define the transportation modes.
• unloadedDistance: unloadedDistance
  The total distance that the truck or the transportation mode will travel when empty.
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• vesselGid: string
  The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.
• volumeUtilization: number (double)
  The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.
• voyageGid: string
  The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.
• waybillDate: waybillDate
  Waybill date represents contractual agreement of the carriage.
• weighCode: string
  The weigh code of the shipment that identifies the weight type.
• weightUtilization: number (double)
  The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.
• workAssignmentBulkPlanGid: string
  Work assignment bulk plan ID which is generated during work assignment bulk plan process.
• workAssignmentGid: string
  The ID of the Work Assignment of which the shipment is part of.

{
    "properties":{
        "shipmentGid":{
            "description":"The GID for the shipment.",
            "type":"string"
        },
        "shipmentXid":{
            "description":"The XID for the shipment.",
            "type":"string"
        },
        "shipmentName":{
            "description":"A descriptive name of the shipment.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"A unique identifier to define the transportation modes.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Indicates whether a shipment is a template.",
            "type":"boolean"
        },
        "isPrimary":{
            "description":"Indicates if the shipment is the primary shipment related to an order (bookings) path.",
            "type":"boolean"
        },
        "isSpotCosted":{
            "description":"Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.",
            "type":"boolean"
        },
        "isCreditNote":{
            "description":"Y/N based on an associated credit note.",
            "type":"boolean"
        },
        "cmPrevDestLocationGid":{
            "description":"The destination location of the previous shipment in the continuous move tour. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cmPrevDestLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "cmNextSourceLocationGid":{
            "description":"The source location of the next shipment in the continuous move tour. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cmNextSourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "totalActualCost":{
            "description":"The total actual cost of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalTransCost":{
            "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "loadedDistance":{
            "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unloadedDistance":{
            "description":"The total distance that the truck or the transportation mode will travel when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID of the source location of the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destLocationGid":{
            "description":"The GID of the destination location of the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "startTime":{
            "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "freightTerms":{
            "description":"The freight terms for the shipment, such as prepaid or collect.",
            "type":"string"
        },
        "parentLegGid":{
            "description":"The parent leg associated with the itinerary that may have been used to plan the shipment.",
            "type":"string"
        },
        "voyageGid":{
            "description":"The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The service provider identifier associated with the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "rateOfferingGid":{
            "description":"The rate offering (contract) identifier that is used by the service provider moving this shipment.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The detailed rate record (contract) identifier that is used by the service provider moving this shipment.",
            "type":"string"
        },
        "originalShipmentGid":{
            "description":"If the shipment represents a secondary charge, this points back to the \"parent\" shipment for which the secondary shipment is a \"child\".",
            "type":"string"
        },
        "shipmentGroupGid":{
            "description":"The shipment group identifier if this shipment is placed into a single group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "isAutoMergeConsolidate":{
            "description":"Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)",
            "type":"boolean"
        },
        "perspective":{
            "description":"The indicates if the shipment is a buy or sell perspective.",
            "type":"string"
        },
        "flightInstanceId":{
            "description":"The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.",
            "type":"number",
            "format":"int64"
        },
        "totalWeight":{
            "description":"The total weight of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"The total volume of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalShipUnitCount":{
            "description":"The total ship unit count of the shipment.",
            "type":"number",
            "format":"int64"
        },
        "totalPackagingUnitCount":{
            "description":"The total packaging unit count of the shipment.",
            "type":"number",
            "format":"int32"
        },
        "totalItemPackageCount":{
            "description":"The total item package count of the shipment.",
            "type":"number",
            "format":"int32"
        },
        "intermediaryCorporationGid":{
            "description":"The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "intermediaryCorporation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/corporations"
                }
            ],
            "readOnly":true
        },
        "shipmentTypeGid":{
            "description":"The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.",
            "type":"string"
        },
        "routeCodeCombinationGid":{
            "description":"The route code combination identifier of the shipment used for specifying rail shipments.",
            "type":"string"
        },
        "railInterModalPlanGid":{
            "description":"The rail intermodal plan identifier of the shipment used for intermodal rail shipments.",
            "type":"string"
        },
        "customerRateCode":{
            "description":"The customer rate identifier associated with the shipment if this shipment is planned using a customer.",
            "type":"string"
        },
        "cofcTofc":{
            "description":"The trailer or flat car or the container on flat car code for rail shipments.",
            "type":"string"
        },
        "railReturnLocationGid":{
            "description":"The rail return location identifier of the rail shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "railReturnLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "railReturnRouteGid":{
            "description":"The rail return route identifier of the rail shipment.",
            "type":"string"
        },
        "rule11Indicator":{
            "description":"The rule 11 indicator of the shipment used for managing rail.",
            "type":"string"
        },
        "currentStopNum":{
            "description":"The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.",
            "type":"number",
            "format":"int32"
        },
        "shipmentAsWork":{
            "description":"Indicates the shipment as work.",
            "type":"boolean"
        },
        "secondaryChargeRuleGid":{
            "description":"The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.",
            "type":"string"
        },
        "checkTimeConstraint":{
            "description":"The indicator to check the time constraints associated with the shipment.",
            "type":"boolean"
        },
        "checkCostConstraint":{
            "description":"The indicator to check cost constraints associated with the shipment",
            "type":"boolean"
        },
        "checkCapacityConstraint":{
            "description":"The indicator to check the capacity constraints associated with the shipment.",
            "type":"boolean"
        },
        "cmName":{
            "description":"The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.",
            "type":"string"
        },
        "cmSequenceNum":{
            "description":"Indicates the shipment's sequence in the continuous move tour.",
            "type":"number",
            "format":"int32"
        },
        "cmCost":{
            "description":"The shipment cost when the shipment is part of a continuous move tour.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "cmEmptyDistance":{
            "description":"The empty leg distance between previous and this shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazmatModeGid":{
            "description":"The hazmat mode identifier that is associated with the shipment.",
            "type":"string"
        },
        "hazmatRegionGid":{
            "description":"The hazmat region identifier that is associated with the shipment.",
            "type":"string"
        },
        "weighCode":{
            "description":"The weigh code of the shipment that identifies the weight type.",
            "type":"string"
        },
        "rule7":{
            "description":"A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.",
            "type":"boolean"
        },
        "shipmentReleased":{
            "description":"A Y/N indicator used for rail shipments that indicate that the shipment is ready.",
            "type":"boolean"
        },
        "processingCodeGid":{
            "description":"The processing code GID.",
            "type":"string"
        },
        "airRailRouteCode":{
            "description":"A transportation mode code that is informational for the shipment.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method code identifier.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The Incoterm identifier associated with the shipment.",
            "type":"string"
        },
        "dimWeight":{
            "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "plannedCost":{
            "description":"The cost when the original shipment was created.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "termLocationText":{
            "description":"The term location text that is informational for the shipment.",
            "type":"string"
        },
        "tariffOrganizationNumber":{
            "description":"The tariff organization number, for informational purposes.",
            "type":"string"
        },
        "tariffOrganizationName":{
            "description":"The tariff organization name, for informational purposes.",
            "type":"string"
        },
        "tariffName":{
            "description":"The tariff name, for informational purposes.",
            "type":"string"
        },
        "tariffNumber":{
            "description":"The tariff number, for informational purposes.",
            "type":"string"
        },
        "tariffDate":{
            "description":"The tariff date, for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "isHazardous":{
            "description":"A Y/N indicator specifying that the shipment is identified as having hazardous material.",
            "type":"boolean"
        },
        "isTemperatureControl":{
            "description":"A Y/N indicator specifying that the shipment is identified as needing temperature control.",
            "type":"boolean"
        },
        "isCostFixed":{
            "description":"A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.",
            "type":"boolean"
        },
        "isServiceTimeFixed":{
            "description":"A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.",
            "type":"boolean"
        },
        "isRateGeoFixed":{
            "description":"A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.",
            "type":"boolean"
        },
        "isRateOfferingFixed":{
            "description":"A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isServprovFixed":{
            "description":"A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isPreload":{
            "description":"A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.",
            "type":"boolean"
        },
        "isFixedTenderContact":{
            "description":"A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isToBeHeld":{
            "description":"A Y/N indicator specifying that the shipment is to be held by the carrier.",
            "type":"boolean"
        },
        "isPreferredCarrier":{
            "description":"Indicates if the carrier selected for the shipment is preferred.",
            "type":"boolean"
        },
        "isEquipmentFixed":{
            "description":"Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.",
            "type":"boolean"
        },
        "isRecalcTotals":{
            "description":"Turns on/off totaling logic.",
            "type":"boolean"
        },
        "hasAppointments":{
            "description":"Indicates if any stops on the shipment have appointments.",
            "type":"boolean"
        },
        "contactGid":{
            "description":"The contact identifier linking in the contact table information to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "bulkPlanGid":{
            "description":"If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.",
            "type":"string"
        },
        "totalNumReferenceUnits":{
            "description":"The total number of reference units of the shipment as defined by the equipment reference units.",
            "type":"number",
            "format":"double"
        },
        "itineraryGid":{
            "description":"The itinerary identifier that was used to build the shipment if it was built with the planning logic. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "itinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "feasibilityCodeGid":{
            "description":"The feasibility code associated with the shipment can identify shipment infeasibilities.",
            "type":"string"
        },
        "numOrderReleases":{
            "description":"The number of order releases that are on this shipment.",
            "type":"number",
            "format":"int32"
        },
        "numStops":{
            "description":"The number of shipment stop records related to this shipment.",
            "type":"number",
            "format":"int32"
        },
        "totalNetWeight":{
            "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalNetVolume":{
            "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "earliestStartTime":{
            "description":"The earliest start time that will make this shipment feasible.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latestStartTime":{
            "description":"The latest start time that will make this shipment feasible.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastEventGroupGid":{
            "description":"The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.",
            "type":"string"
        },
        "repetitionScheduleGid":{
            "description":"The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.",
            "type":"string"
        },
        "inTrailerBuild":{
            "description":"Indicates that this shipment is in a trailer build shipment group.",
            "type":"boolean"
        },
        "firstEquipmentGroupGid":{
            "description":"A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.",
            "type":"string"
        },
        "bulkCmGid":{
            "description":"The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.",
            "type":"string"
        },
        "vesselGid":{
            "description":"The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "sourceLocationOverrideGid":{
            "description":"The location identifier that will override the source location that is defined for the shipment.",
            "type":"string"
        },
        "destLocationOverrideGid":{
            "description":"The location identifier that will override the destination location that is defined for the shipment.",
            "type":"string"
        },
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.",
            "type":"string"
        },
        "scheduleType":{
            "description":"When the schedule type is populated, it is a consol.",
            "type":"string"
        },
        "weightUtilization":{
            "description":"The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "volumeUtilization":{
            "description":"The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "equipRefUnitUtilization":{
            "description":"The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "jobGid":{
            "description":"The job GID identifier of the shipment, if the shipment is assigned to a job.",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"The location ID of the port of load for the primary leg carrier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfLoadLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfLoadOverrideLocGid":{
            "description":"The location override ID of the port of load for the primary leg carrier.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"The location ID of the port of discharge for the primary leg carrier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfDisLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfDisOverrideLocGid":{
            "description":"The location override ID of the port of discharge for the primary leg carrier.",
            "type":"string"
        },
        "insurancePolicyNumber":{
            "description":"The insurance policy number that covers this shipment, for informational purposes.",
            "type":"string"
        },
        "insuranceAmount":{
            "description":"The insurance amount of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "insurancePremium":{
            "description":"The insurance premium of the shipment, for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "bolType":{
            "description":"The bill of lading type defined for the shipment, used for report management.",
            "type":"string"
        },
        "bolIssuanceType":{
            "description":"The bill of lading issuance type identifier.",
            "type":"string"
        },
        "consolGid":{
            "description":"The consol identifier if the shipment has been built from a consol structure. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "consol":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/consols"
                }
            ],
            "readOnly":true
        },
        "placeReceiptLocationGid":{
            "description":"The place receipt location identifier specifying the location where ownership of freight starts. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "placeReceiptLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "placeDeliverLocationGid":{
            "description":"The place deliver location identifier specifying the location where ownership of freight ends with delivery. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "placeDeliverLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sailDate":{
            "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "railDate":{
            "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sailCutoffDate":{
            "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portDischargeEta":{
            "description":"The estimated port of discharge date associated with ocean-going shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portOfExitDate":{
            "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portExitLocGid":{
            "description":"The designated port the freight will be exiting the country for international shipments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portExitLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "containerDeliveryLocGid":{
            "description":"The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "containerDeliveryLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "containerPickupLocGid":{
            "description":"The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "containerPickupLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "nfrcRuleGid":{
            "description":"The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.",
            "type":"string"
        },
        "isCpctyOverrideApplicable":{
            "description":"A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.",
            "type":"boolean"
        },
        "plannedRateOfferingGid":{
            "description":"The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "plannedTransportModeGid":{
            "description":"The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "plannedServprovGid":{
            "description":"The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "plannedServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "plannedRateGeoGid":{
            "description":"The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "isPermanent":{
            "description":"Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in \"delete shipment\" action.",
            "type":"boolean"
        },
        "isMemoBl":{
            "description":"Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.",
            "type":"boolean"
        },
        "dutyPaid":{
            "description":"The duty paid of the shipment.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "currencyGid":{
            "description":"Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.",
            "type":"string"
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "totMatchedInvoiceCost":{
            "description":"The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "originalInvoiceCost":{
            "description":"The original invoice cost at the point when the invoice was initially created or matched to the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalApprovedCost":{
            "description":"The total approved cost associated with the shipment after the approval step in the freight payment process.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "sourcePierLocationGid":{
            "description":"The source operational location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourcePierLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destPierLocationGid":{
            "description":"The destination operational location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destPierLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "primaryOrderBaseGid":{
            "description":"A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "primaryOrderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "totalDeclaredValue":{
            "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isProfitSplit":{
            "description":"Indicates if the NFRC shipment will be profit split.",
            "type":"boolean"
        },
        "shippingAgentContactGid":{
            "description":"Indicate if this NFRC is created from the Assign Shipping Agent action on the job.",
            "type":"string"
        },
        "isAdvancedCharge":{
            "description":"A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.",
            "type":"boolean"
        },
        "loadConfigEngineTypeGid":{
            "description":"Null type means no load configuration is performed on the shipment.",
            "type":"string"
        },
        "appointmentPriorityGid":{
            "description":"The appointment priority identifier associated with the shipment.",
            "type":"string"
        },
        "isFixedDistance":{
            "description":"Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.",
            "type":"boolean"
        },
        "deliveringServprovGid":{
            "description":"The service provider who is the delivering service provider for this shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "deliveringServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "originatingServprovGid":{
            "description":"The service provider who is the originating service provider for this shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "originatingServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "chargeableWeight":{
            "description":"The dimensional weight as determined by the rating process.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "fixedServiceDays":{
            "description":"The fixed number of service days, if returned by the rating engine.",
            "type":"number",
            "format":"int32"
        },
        "sightingLocationGid":{
            "description":"The location where the shipment was last sighted. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sightingDate":{
            "description":"The date and time when the shipment was last sighted at the sighting location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "prevSightingLocationGid":{
            "description":"The location identifier for the previous sighting location used for rail shipment and tracking events. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "prevSightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevSightingDate":{
            "description":"The date associated with the previous sighting location and in the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "driverGid":{
            "description":"The driver or primary team driver assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "driver":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/drivers"
                }
            ],
            "readOnly":true
        },
        "secondaryDriverGid":{
            "description":"The secondary team driver assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "secondaryDriver":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/drivers"
                }
            ],
            "readOnly":true
        },
        "powerUnitGid":{
            "description":"The power unit assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "powerUnit":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/powerUnits"
                }
            ],
            "readOnly":true
        },
        "driverAssignBulkPlanGid":{
            "description":"Fleet bulk plan ID for driver assignment.",
            "type":"string"
        },
        "equipmentAssignBulkPlanGid":{
            "description":"Fleet bulk plan ID for equipment assignment.",
            "type":"string"
        },
        "prevDropInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for driver's previous shipment's equipment.",
            "type":"boolean"
        },
        "pickInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for picking an empty equipment before freight.",
            "type":"boolean"
        },
        "dropInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for dropping an empty equipment after freight.",
            "type":"boolean"
        },
        "dimVolume":{
            "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "chargeableVolume":{
            "description":"The actual volume used in calculating the cost of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"The database domain where this data is stored.",
            "type":"string"
        },
        "planningParameterSetGid":{
            "description":"The parameter set GID which is used in building this shipment.",
            "type":"string"
        },
        "numEquipmentOrdered":{
            "description":"The number of equipment ordered. This is manually set by the user and can be rated on.",
            "type":"number",
            "format":"int32"
        },
        "emPhoneNumber":{
            "description":"The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.",
            "type":"string"
        },
        "parcelZone":{
            "description":"The ship to mail zone. A price key used for parcel rate calculations.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "combinationEquipGrpGid":{
            "description":"The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "combinationEquipGrp":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "siCutoffDate":{
            "description":"The shippers instruction cutoff date associated with the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "cfsCutoffDate":{
            "description":"The container freight station cutoff date associated with the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "srcArbLevelOfServiceGid":{
            "description":"The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.",
            "type":"string"
        },
        "destArbLevelOfServiceGid":{
            "description":"The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.",
            "type":"string"
        },
        "cfsLocationGid":{
            "description":"The location identifier for the container freight station. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cfsLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "isFixedVoyage":{
            "description":"A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.",
            "type":"boolean"
        },
        "workAssignmentBulkPlanGid":{
            "description":"Work assignment bulk plan ID which is generated during work assignment bulk plan process.",
            "type":"string"
        },
        "aheadLateTime":{
            "description":"shipment status",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aheadOrLate":{
            "description":"A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user.  B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed  ",
            "type":"string"
        },
        "etaDate":{
            "description":"Estimated time of arrival",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "firstEquipmentInitial":{
            "description":"first equipment intial",
            "type":"string"
        },
        "firstEquipmentNumber":{
            "description":"first equipment number",
            "type":"string"
        },
        "solePackagedItemGid":{
            "description":"only one equipment and with only one item \t <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "solePackagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "reportedBsStatusCode":{
            "description":"latest reported event for shipment",
            "type":"string"
        },
        "reportingScac":{
            "description":"reporting scac",
            "type":"string"
        },
        "equipmentDestination":{
            "description":"equipment destination <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentDestinationRefObject":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevReportedBsStatusCode":{
            "description":"previous reported event for shipment",
            "type":"string"
        },
        "prevReportingScac":{
            "description":"previous reporting scac",
            "type":"string"
        },
        "prevEquipmentDestination":{
            "description":"previous equipment destination <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "prevEquipmentDestinationRefObject":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "maxNumRetender":{
            "description":"Maximum number of re-tenders.",
            "type":"number",
            "format":"int32"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "reservationNum":{
            "description":"Saved here to search shipments based on Reservation Number.",
            "type":"string"
        },
        "isArRouteCodeFixed":{
            "description":"This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.",
            "type":"boolean"
        },
        "waybillDate":{
            "description":"Waybill date represents contractual agreement of the carriage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "projectedTourName":{
            "description":"Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.",
            "type":"string"
        },
        "projectedTourSequenceNum":{
            "description":"Represents the sequence in which the shipment should appear in the projected tour.",
            "type":"number",
            "format":"int32"
        },
        "externalVoyageCode":{
            "description":"Specifies the number of the voyage as assigned by the carrier that transports the shipment.",
            "type":"string"
        },
        "plannedCo2Emission":{
            "description":"CO2 emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2Emission":{
            "description":"Actual CO2 emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "plannedCo2EqEmission":{
            "description":"CO2 equivalent emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2EqEmission":{
            "description":"Actual CO2 equivalent emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "marketCost":{
            "description":"Market cost based on the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "loadingHallPenalty":{
            "description":"The loading hall penalty used while building loading halls for the shipment.",
            "type":"number",
            "format":"double"
        },
        "workAssignmentGid":{
            "description":"The ID of the Work Assignment of which the shipment is part of.",
            "type":"string"
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/vouchers.shipments.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCo2Emission

Actual CO2 emissions for the shipment.

Match All

Actual CO2 emissions for the shipment.

Show Source

• object amountType

{
    "description":"Actual CO2 emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualCo2EqEmission

Actual CO2 equivalent emissions for the shipment.

Match All

Actual CO2 equivalent emissions for the shipment.

Show Source

• object amountType

{
    "description":"Actual CO2 equivalent emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : aheadLateTime

shipment status

Match All

shipment status

Show Source

• object amountType

{
    "description":"shipment status",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cfsCutoffDate

The container freight station cutoff date associated with the shipment.

Match All

The container freight station cutoff date associated with the shipment.

Show Source

• object dateTimeType

{
    "description":"The container freight station cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cfsLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : chargeableVolume

The actual volume used in calculating the cost of the shipment.

Match All

The actual volume used in calculating the cost of the shipment.

Show Source

• object amountType

{
    "description":"The actual volume used in calculating the cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : chargeableWeight

The dimensional weight as determined by the rating process.

Match All

The dimensional weight as determined by the rating process.

Show Source

• object amountType

{
    "description":"The dimensional weight as determined by the rating process.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : cmCost

The shipment cost when the shipment is part of a continuous move tour.

Match All

The shipment cost when the shipment is part of a continuous move tour.

Show Source

• object currencyType

{
    "description":"The shipment cost when the shipment is part of a continuous move tour.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : cmEmptyDistance

The empty leg distance between previous and this shipments.

Match All

The empty leg distance between previous and this shipments.

Show Source

• object amountType

{
    "description":"The empty leg distance between previous and this shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : cmNextSourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : cmPrevDestLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : combinationEquipGrp

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : consol

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/consols"
        }
    ],
    "readOnly":true
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : containerDeliveryLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : containerPickupLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : deliveringServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : destLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : destPierLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : dimVolume

The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.

Match All

The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.

Show Source

• object amountType

{
    "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : dimWeight

The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.

Match All

The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.

Show Source

• object amountType

{
    "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : driver

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object drivers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/drivers"
        }
    ],
    "readOnly":true
}

Nested Schema : earliestStartTime

The earliest start time that will make this shipment feasible.

Match All

The earliest start time that will make this shipment feasible.

Show Source

• object dateTimeType

{
    "description":"The earliest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : endTime

The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Match All

The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Show Source

• object dateTimeType

{
    "description":"The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentDestinationRefObject

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : etaDate

Estimated time of arrival

Match All

Estimated time of arrival

Show Source

• object dateTimeType

{
    "description":"Estimated time of arrival",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insuranceAmount

The insurance amount of the shipment.

Match All

The insurance amount of the shipment.

Show Source

• object currencyType

{
    "description":"The insurance amount of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : insurancePremium

The insurance premium of the shipment, for informational purposes.

Match All

The insurance premium of the shipment, for informational purposes.

Show Source

• object currencyType

{
    "description":"The insurance premium of the shipment, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : intermediaryCorporation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/corporations"
        }
    ],
    "readOnly":true
}

Nested Schema : itinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : latestStartTime

The latest start time that will make this shipment feasible.

Match All

The latest start time that will make this shipment feasible.

Show Source

• object dateTimeType

{
    "description":"The latest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : loadedDistance

The total distance that the truck or the transportation mode will travel when the shipment is loaded.

Match All

The total distance that the truck or the transportation mode will travel when the shipment is loaded.

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : marketCost

Market cost based on the shipment.

Match All

Market cost based on the shipment.

Show Source

• object currencyType

{
    "description":"Market cost based on the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : originalInvoiceCost

The original invoice cost at the point when the invoice was initially created or matched to the shipment.

Match All

The original invoice cost at the point when the invoice was initially created or matched to the shipment.

Show Source

• object currencyType

{
    "description":"The original invoice cost at the point when the invoice was initially created or matched to the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : originatingServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : placeDeliverLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : placeReceiptLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : plannedCo2Emission

CO2 emissions recorded while planning the shipment.

Match All

CO2 emissions recorded while planning the shipment.

Show Source

• object amountType

{
    "description":"CO2 emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCo2EqEmission

CO2 equivalent emissions recorded while planning the shipment.

Match All

CO2 equivalent emissions recorded while planning the shipment.

Show Source

• object amountType

{
    "description":"CO2 equivalent emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCost

The cost when the original shipment was created.

Match All

The cost when the original shipment was created.

Show Source

• object currencyType

{
    "description":"The cost when the original shipment was created.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : plannedServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : portDischargeEta

The estimated port of discharge date associated with ocean-going shipments.

Match All

The estimated port of discharge date associated with ocean-going shipments.

Show Source

• object dateTimeType

{
    "description":"The estimated port of discharge date associated with ocean-going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : portExitLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfDisLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfExitDate

The estimated port of exit (for international shipments) associated with ocean going shipments.

Match All

The estimated port of exit (for international shipments) associated with ocean going shipments.

Show Source

• object dateTimeType

{
    "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : portOfLoadLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : powerUnit

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/powerUnits"
        }
    ],
    "readOnly":true
}

Nested Schema : prevEquipmentDestinationRefObject

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingDate

The date associated with the previous sighting location and in the tracking event.

Match All

The date associated with the previous sighting location and in the tracking event.

Show Source

• object dateTimeType

{
    "description":"The date associated with the previous sighting location and in the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : prevSightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : primaryOrderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : railDate

The rail date of the shipment that is populated if the shipment utilizes the rail schedules.

Match All

The rail date of the shipment that is populated if the shipment utilizes the rail schedules.

Show Source

• object dateTimeType

{
    "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : railReturnLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/vouchers.shipments.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sailCutoffDate

The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.

Match All

The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.

Show Source

• object dateTimeType

{
    "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sailDate

The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.

Match All

The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.

Show Source

• object dateTimeType

{
    "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : secondaryDriver

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object drivers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/drivers"
        }
    ],
    "readOnly":true
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : shipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : siCutoffDate

The shippers instruction cutoff date associated with the shipment.

Match All

The shippers instruction cutoff date associated with the shipment.

Show Source

• object dateTimeType

{
    "description":"The shippers instruction cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingDate

The date and time when the shipment was last sighted at the sighting location.

Match All

The date and time when the shipment was last sighted at the sighting location.

Show Source

• object dateTimeType

{
    "description":"The date and time when the shipment was last sighted at the sighting location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : solePackagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : sourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : sourcePierLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : startTime

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Match All

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Show Source

• object dateTimeType

{
    "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : tariffDate

The tariff date, for informational purposes.

Match All

The tariff date, for informational purposes.

Show Source

• object dateType

{
    "description":"The tariff date, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : totalActualCost

The total actual cost of the shipment.

Match All

The total actual cost of the shipment.

Show Source

• object currencyType

{
    "description":"The total actual cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalApprovedCost

The total approved cost associated with the shipment after the approval step in the freight payment process.

Match All

The total approved cost associated with the shipment after the approval step in the freight payment process.

Show Source

• object currencyType

{
    "description":"The total approved cost associated with the shipment after the approval step in the freight payment process.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalDeclaredValue

The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.

Match All

The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.

Show Source

• object currencyType

{
    "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalNetVolume

The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.

Match All

The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.

Show Source

• object amountType

{
    "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalNetWeight

The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.

Match All

The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.

Show Source

• object amountType

{
    "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalTransCost

The total cost of the shipment. It represents the total transportation cost after applying the rebate.

Match All

The total cost of the shipment. It represents the total transportation cost after applying the rebate.

Show Source

• object currencyType

{
    "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalVolume

The total volume of the shipment.

Match All

The total volume of the shipment.

Show Source

• object amountType

{
    "description":"The total volume of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

The total weight of the shipment.

Match All

The total weight of the shipment.

Show Source

• object amountType

{
    "description":"The total weight of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeightedCost

The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.

Match All

The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.

Show Source

• object currencyType

{
    "description":"The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totMatchedInvoiceCost

The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.

Match All

The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.

Show Source

• object currencyType

{
    "description":"The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : unloadedDistance

The total distance that the truck or the transportation mode will travel when empty.

Match All

The total distance that the truck or the transportation mode will travel when empty.

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : waybillDate

Waybill date represents contractual agreement of the carriage.

Match All

Waybill date represents contractual agreement of the carriage.

Show Source

• object dateTimeType

{
    "description":"Waybill date represents contractual agreement of the carriage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• allocatedNumFeu: number (double)
  Allocated FEU represents the original agreed-upon forty foot equivalent unit capacity for this stowage mode on the charter voyage.
• allocatedNumTeu: number (double)
  Allocated TEU represents the original agreed-upon twenty foot equivalent unit capacity for this stowage mode on the charter voyage.
• allocatedVolume: allocatedVolume
  Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.
• allocatedWeight: allocatedWeight
  Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• bookedNumFeu: number (double)
  Represents the booked FEU capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
• bookedNumTeu: number (double)
  Represents the booked TEU capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
• bookedVolume: bookedVolume
  Represents the booked volume capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
• bookedWeight: bookedWeight
  Represents the booked weight capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).
• charterVoyageGid: string
  The GID for the charter voyage associated with the consol. Charter voyage is assigned for consol type of Charter Voyage Stowage.
• committedNumFeu: number (double)
  Committed FEU represents the committed number of forty foot equivalent unit capacity for this stowage mode on the charter voyage. The committed FEU can only be edited when the consol status is READY-TO-COMMIT.
• committedNumTeu: number (double)
  Committed number of TEU represents the committed number of twenty foot equivalent unit capacity for this stowage mode on the charter voyage. The committed TEU can only be edited when the consol status is READY-TO-COMMIT.
• committedVolume: committedVolume
  Committed volume represents the committed capacity for this stowage mode on the charter voyage. The committed volume can only be edited when the consol status is READY-TO-COMMIT.
• committedWeight: committedWeight
  Committed weight represents the committed capacity on the pre-bookings for this stowage mode on the charter voyage. The committed weight can only be edited when the consol status is READY-TO-COMMIT.
• consolGid: string
  The GID for the consol.
• consolGroup: consolGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property consolGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• consolGroupGid: string
  The GID for the consol group being defined.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• consolidationTypeGid: string
  The GID for the assigned consolidation type on the consol. A consolidation type can be assigned to any order release or job for informational purposes. Consolidation types can also be included in a consolidation type profile that can then be used as criteria for the automatic assignment of non-freight related charges to a job.
• consolType: string
  Consol type can be Charter Voyage Stowage, Flight, or Ocean FCL.
• consolXid: string
  The XID for the consol.
• cutoffTime: cutoffTime
  A duration that is subtracted from the consol shipment departure time and populated as the Operation Late Delivery Date of the previous leg order movement.
• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The GID for the equipment group reference unit being defined.
• flexCommodityCode: string
  The user-defined commodity code. E.g.. the HTS, NMFC, SITC, STCC codes.
• flexCommodityProfileGid: string
  The flexible commodity profile ID that associates to the consol.
• flexCommodityQualGid: string
  A GID to define the type of the code. E.g.. HTS, SITC, STCC, NMFC etc.
• flightInstanceId: number (int64)
  The flight instance ID this consol is created from when the consol is a flight consol.
• hazmatType: string
  Hazmat type. One of three values: HAZMAT ONLY, NO HAZMAT, HAZMAT ALLOWED.
• incoTermGid: string
  The GID for the incoterms associated with the consol.
• insertDate: insertDate
  Read Only: true

  insert date
• intendedArrivalTime: intendedArrivalTime
  Intended estimated time of arrival.
• intendedDepartureTime: intendedDepartureTime
  Intended estimated time of departure.
• intendedGroundServiceGid: string
  The intended ground service gid. The ground service gid may not be in the system yet and therefore there is no foreign key restriction.
• intendedVesselGid: string
  The intended vessel gid. The vessel gid may not be in the system yet and therefore there is no foreign key restriction.
• intendedVoyageGid: string
  The intended voyage gid. The voyage gid may not be in the system yet and therefore there is no foreign key restriction.
• itineraryProfileGid: string
  The GID for the assigned itinerary profile. The itinerary profile defines the consol's applicability to legs.
• links: array links
  Read Only: true
• maxNumEquipment: number (int32)
  The maximum number of equipment that can be held in the consol.
• maxNumFeu: number (double)
  Maximum FEU represents the maximum forty foot equivalent unit capacity for this stowage mode on the charter voyage.
• maxNumReferenceUnits: number (double)
  The maximum number of equipment reference units that can be held in the consol.
• maxNumTeu: number (double)
  Maximum number of TEU represents the maximum twenty foot equivalent unit capacity for this stowage mode on the charter voyage.
• maxVolume: maxVolume
  Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.
• maxWeight: maxWeight
  Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.
• oneShipmentPerContainer: boolean
  This flag will only be used when consol_type is OCEAN FCL. If it is 'Y', one shipment will be created for each container specified on the consol. If it is 'N', one shipment will be created for all the containers specified on the consol. The default value is 'N'.
• perspective: string
  Perspective - Buy or Sell.
• placeDeliverLocation: placeDeliverLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• placeDeliverLocationGid: string
  Specifies a place of delivery other than the port of discharge. If specified this will add a stop to the consol shipment created.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• placeReceiptLocation: placeReceiptLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• placeReceiptLocationGid: string
  Specifies a place of receipt location other than the port of loading. If specified this will add a stop to the consol shipment created.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfDisLocation: portOfDisLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfDisLocationGid: string
  The port of discharge for transport.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfLoadLocation: portOfLoadLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfLoadLocationGid: string
  The port of loading for transport.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• producedNumFeu: number (double)
  Produced FEU is a FEU value that is not calculated and is user-defined.
• producedNumTeu: number (double)
  Produced TEU is a TEU value that is not calculated and is user-defined.
• producedVolume: producedVolume
  Produced volume is a volume values that is not calculated and is user-defined.
• producedWeight: producedWeight
  Produced weight is a weight values that is not calculated and is user-defined.
• refnums: refnums
• remarks: remarks
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The GID for the carrier. If blank, look at the voyage table.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• statuses: statuses
• stowageModeGid: string
  The GID for the stowage mode related to this consol. Stowage modes provide a way to identify how the shipment will be stowed. When an order release is booked for a voyage, the system needs to determine the best stowage mode and subsequently the best voyage that supports that stowage mode. To determine the best stowage mode, you can create preference rules that are evaluated. This rule will, based on certain attributes on the order release, provide a preferred list of stowage modes that can be used for that order. Note: You can also define a stowage mode directly on an order and it will override any stowage mode preference rules.
• transportModeGid: string
  The GID for the transportation mode for the consol.
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
• userDefined2IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
• userDefined3IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
• userDefined4IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.
• userDefined5IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.

{
    "properties":{
        "consolGid":{
            "description":"The GID for the consol.",
            "type":"string"
        },
        "consolXid":{
            "description":"The XID for the consol.",
            "type":"string"
        },
        "consolType":{
            "description":"Consol type can be Charter Voyage Stowage, Flight, or Ocean FCL.",
            "type":"string"
        },
        "charterVoyageGid":{
            "description":"The GID for the charter voyage associated with the consol. Charter voyage is assigned for consol type of Charter Voyage Stowage.",
            "type":"string"
        },
        "stowageModeGid":{
            "description":"The GID for the stowage mode related to this consol. Stowage modes provide a way to identify how the shipment will be stowed. When an order release is booked for a voyage, the system needs to determine the best stowage mode and subsequently the best voyage that supports that stowage mode. To determine the best stowage mode, you can create preference rules that are evaluated. This rule will, based on certain attributes on the order release, provide a preferred list of stowage modes that can be used for that order. Note: You can also define a stowage mode directly on an order and it will override any stowage mode preference rules.",
            "type":"string"
        },
        "allocatedWeight":{
            "description":"Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "allocatedVolume":{
            "description":"Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "allocatedNumTeu":{
            "description":"Allocated TEU represents the original agreed-upon twenty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "allocatedNumFeu":{
            "description":"Allocated FEU represents the original agreed-upon forty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "maxWeight":{
            "description":"Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxNumTeu":{
            "description":"Maximum number of TEU represents the maximum twenty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "maxNumFeu":{
            "description":"Maximum FEU represents the maximum forty foot equivalent unit capacity for this stowage mode on the charter voyage.",
            "type":"number",
            "format":"double"
        },
        "committedWeight":{
            "description":"Committed weight represents the committed capacity on the pre-bookings for this stowage mode on the charter voyage. The committed weight can only be edited when the consol status is READY-TO-COMMIT.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "committedVolume":{
            "description":"Committed volume represents the committed capacity for this stowage mode on the charter voyage. The committed volume can only be edited when the consol status is READY-TO-COMMIT.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "committedNumTeu":{
            "description":"Committed number of TEU represents the committed number of twenty foot equivalent unit capacity for this stowage mode on the charter voyage. The committed TEU can only be edited when the consol status is READY-TO-COMMIT.",
            "type":"number",
            "format":"double"
        },
        "committedNumFeu":{
            "description":"Committed FEU represents the committed number of forty foot equivalent unit capacity for this stowage mode on the charter voyage. The committed FEU can only be edited when the consol status is READY-TO-COMMIT.",
            "type":"number",
            "format":"double"
        },
        "bookedWeight":{
            "description":"Represents the booked weight capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bookedVolume":{
            "description":"Represents the booked volume capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bookedNumTeu":{
            "description":"Represents the booked TEU capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).",
            "type":"number",
            "format":"double"
        },
        "bookedNumFeu":{
            "description":"Represents the booked FEU capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).",
            "type":"number",
            "format":"double"
        },
        "producedWeight":{
            "description":"Produced weight is a weight values that is not calculated and is user-defined.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "producedVolume":{
            "description":"Produced volume is a volume values that is not calculated and is user-defined.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "producedNumTeu":{
            "description":"Produced TEU is a TEU value that is not calculated and is user-defined.",
            "type":"number",
            "format":"double"
        },
        "producedNumFeu":{
            "description":"Produced FEU is a FEU value that is not calculated and is user-defined.",
            "type":"number",
            "format":"double"
        },
        "perspective":{
            "description":"Perspective - Buy or Sell.",
            "type":"string"
        },
        "flightInstanceId":{
            "description":"The flight instance ID this consol is created from when the consol is a flight consol.",
            "type":"number",
            "format":"int64"
        },
        "hazmatType":{
            "description":"Hazmat type. One of three values: HAZMAT ONLY, NO HAZMAT, HAZMAT ALLOWED.",
            "type":"string"
        },
        "itineraryProfileGid":{
            "description":"The GID for the assigned itinerary profile. The itinerary profile defines the consol's applicability to legs.",
            "type":"string"
        },
        "consolidationTypeGid":{
            "description":"The GID for the assigned consolidation type on the consol. A consolidation type can be assigned to any order release or job for informational purposes. Consolidation types can also be included in a consolidation type profile that can then be used as criteria for the automatic assignment of non-freight related charges to a job.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes for the object.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "placeReceiptLocationGid":{
            "description":"Specifies a place of receipt location other than the port of loading. If specified this will add a stop to the consol shipment created. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "placeReceiptLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "placeDeliverLocationGid":{
            "description":"Specifies a place of delivery other than the port of discharge. If specified this will add a stop to the consol shipment created. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "placeDeliverLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfLoadLocationGid":{
            "description":"The port of loading for transport. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfLoadLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfDisLocationGid":{
            "description":"The port of discharge for transport. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfDisLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "incoTermGid":{
            "description":"The GID for the incoterms associated with the consol.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the carrier. If blank, look at the voyage table. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "transportModeGid":{
            "description":"The GID for the transportation mode for the consol.",
            "type":"string"
        },
        "intendedVesselGid":{
            "description":"The intended vessel gid. The vessel gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "intendedVoyageGid":{
            "description":"The intended voyage gid. The voyage gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "intendedDepartureTime":{
            "description":"Intended estimated time of departure.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "intendedArrivalTime":{
            "description":"Intended estimated time of arrival.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "flexCommodityQualGid":{
            "description":"A GID to define the type of the code. E.g.. HTS, SITC, STCC, NMFC etc.",
            "type":"string"
        },
        "flexCommodityCode":{
            "description":"The user-defined commodity code. E.g.. the HTS, NMFC, SITC, STCC codes.",
            "type":"string"
        },
        "oneShipmentPerContainer":{
            "description":"This flag will only be used when consol_type is OCEAN FCL. If it is 'Y', one shipment will be created for each container specified on the consol. If it is 'N', one shipment will be created for all the containers specified on the consol. The default value is 'N'.",
            "type":"boolean"
        },
        "flexCommodityProfileGid":{
            "description":"The flexible commodity profile ID that associates to the consol.",
            "type":"string"
        },
        "equipmentReferenceUnitGid":{
            "description":"The GID for the equipment group reference unit being defined.",
            "type":"string"
        },
        "maxNumReferenceUnits":{
            "description":"The maximum number of equipment reference units that can be held in the consol.",
            "type":"number",
            "format":"double"
        },
        "maxNumEquipment":{
            "description":"The maximum number of equipment that can be held in the consol.",
            "type":"number",
            "format":"int32"
        },
        "intendedGroundServiceGid":{
            "description":"The intended ground service gid. The ground service gid may not be in the system yet and therefore there is no foreign key restriction.",
            "type":"string"
        },
        "cutoffTime":{
            "description":"A duration that is subtracted from the consol shipment departure time and populated as the Operation Late Delivery Date of the previous leg order movement.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "consolGroupGid":{
            "description":"The GID for the consol group being defined. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "consolGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property consolGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/consolGroups"
                }
            ],
            "readOnly":true
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/consols.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedVolume

Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.

Match All

Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.

Show Source

• object amountType

{
    "description":"Allocated volume represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : allocatedWeight

Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.

Match All

Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.

Show Source

• object amountType

{
    "description":"Allocated weight represents the original agreed-upon capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : bookedVolume

Represents the booked volume capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).

Match All

Represents the booked volume capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).

Show Source

• object amountType

{
    "description":"Represents the booked volume capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : bookedWeight

Represents the booked weight capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).

Match All

Represents the booked weight capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).

Show Source

• object amountType

{
    "description":"Represents the booked weight capacity that is booked on the voyage for shipments planned using order releases (production lot orders). These values are calculated each time an order is booked on the consol using the Build Buy Shipment on Primary Leg action (from the Order Release manager).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : committedVolume

Committed volume represents the committed capacity for this stowage mode on the charter voyage. The committed volume can only be edited when the consol status is READY-TO-COMMIT.

Match All

Committed volume represents the committed capacity for this stowage mode on the charter voyage. The committed volume can only be edited when the consol status is READY-TO-COMMIT.

Show Source

• object amountType

{
    "description":"Committed volume represents the committed capacity for this stowage mode on the charter voyage. The committed volume can only be edited when the consol status is READY-TO-COMMIT.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : committedWeight

Committed weight represents the committed capacity on the pre-bookings for this stowage mode on the charter voyage. The committed weight can only be edited when the consol status is READY-TO-COMMIT.

Match All

Committed weight represents the committed capacity on the pre-bookings for this stowage mode on the charter voyage. The committed weight can only be edited when the consol status is READY-TO-COMMIT.

Show Source

• object amountType

{
    "description":"Committed weight represents the committed capacity on the pre-bookings for this stowage mode on the charter voyage. The committed weight can only be edited when the consol status is READY-TO-COMMIT.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : consolGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property consolGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property consolGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object consolGroups

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property consolGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/consolGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : cutoffTime

A duration that is subtracted from the consol shipment departure time and populated as the Operation Late Delivery Date of the previous leg order movement.

Match All

A duration that is subtracted from the consol shipment departure time and populated as the Operation Late Delivery Date of the previous leg order movement.

Show Source

• object amountType

{
    "description":"A duration that is subtracted from the consol shipment departure time and populated as the Operation Late Delivery Date of the previous leg order movement.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : intendedArrivalTime

Intended estimated time of arrival.

Match All

Intended estimated time of arrival.

Show Source

• object dateTimeType

{
    "description":"Intended estimated time of arrival.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : intendedDepartureTime

Intended estimated time of departure.

Match All

Intended estimated time of departure.

Show Source

• object dateTimeType

{
    "description":"Intended estimated time of departure.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxVolume

Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.

Match All

Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.

Show Source

• object amountType

{
    "description":"Maximum volume represents the maximum capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.

Match All

Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.

Show Source

• object amountType

{
    "description":"Maximum weight represents the maximum capacity for this stowage mode on the charter voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : placeDeliverLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : placeReceiptLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfDisLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfLoadLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : producedVolume

Produced volume is a volume values that is not calculated and is user-defined.

Match All

Produced volume is a volume values that is not calculated and is user-defined.

Show Source

• object amountType

{
    "description":"Produced volume is a volume values that is not calculated and is user-defined.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : producedWeight

Produced weight is a weight values that is not calculated and is user-defined.

Match All

Produced weight is a weight values that is not calculated and is user-defined.

Show Source

• object amountType

{
    "description":"Produced weight is a weight values that is not calculated and is user-defined.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/consols.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : consolGroups

Type: object

Show Source

• consolGroupGid: string
  The GID for the consol_group.
• consolGroupXid: string
  The XID for the consol_group.
• domainName: string
  No description.
• equipmentReferenceUnitGid: string
  The GID for the equipment reference unit being defined.
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• maxNumEquipment: number (int32)
  Maximum number of equipment for all the consols with this consol group.
• maxNumReferenceUnits: number (double)
  Maximum number of equipment reference units for all the consols with this consol group.
• maxVolume: maxVolume
  Maximum volume for all the consols with this consol group.
• maxWeight: maxWeight
  Maximum weight for all the consols with this consol group.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "consolGroupGid":{
            "description":"The GID for the consol_group.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "consolGroupXid":{
            "description":"The XID for the consol_group.",
            "type":"string"
        },
        "maxNumEquipment":{
            "description":"Maximum number of equipment for all the consols with this consol group.",
            "type":"number",
            "format":"int32"
        },
        "maxWeight":{
            "description":"Maximum weight for all the consols with this consol group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maxVolume":{
            "description":"Maximum volume for all the consols with this consol group.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "equipmentReferenceUnitGid":{
            "description":"The GID for the equipment reference unit being defined.",
            "type":"string"
        },
        "maxNumReferenceUnits":{
            "description":"Maximum number of equipment reference units for all the consols with this consol group.",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maxVolume

Maximum volume for all the consols with this consol group.

Match All

Maximum volume for all the consols with this consol group.

Show Source

• object amountType

{
    "description":"Maximum volume for all the consols with this consol group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxWeight

Maximum weight for all the consols with this consol group.

Match All

Maximum weight for all the consols with this consol group.

Show Source

• object amountType

{
    "description":"Maximum weight for all the consols with this consol group.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• consolRefnumQualGid: string
  The GID for the reference number qualifier.
• consolRefnumValue: string
  Value entered for the consol reference number.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "consolRefnumQualGid":{
            "description":"The GID for the reference number qualifier.",
            "type":"string"
        },
        "consolRefnumValue":{
            "description":"Value entered for the consol reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier.
• remarkSequence: number (int64)
  Sequence number for remark - not visible in the UI.
• remarkText: string
  Remark text.

{
    "properties":{
        "remarkSequence":{
            "description":"Sequence number for remark - not visible in the UI.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/consols.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  Status type for the consol status
• statusValueGid: string
  Value of status type

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the consol status",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers

Type: object

Show Source

• adjHireDate: adjHireDate
  Adjusted hire date.
• assignments: assignments
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• calendarEvents: calendarEvents
• calendars: calendars
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The contact user linked to the driver.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• corporationProfileGid: string
  The corporations for which this driver works.
• dateOfBirth: dateOfBirth
  The driver's date of birth.
• dedAcctLocnProfileGid: string
  The location profile of the driver's dedicated account.
• defHomeLoc: defHomeLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property defHomeLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• defHomeLocGid: string
  Driver's Home Location ID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documents: documents
• domainName: string
  Database domain where this data is stored.
• driverAssignmentSeqNum: number (int64)
  Read Only: true

  Reflects the latest Driver Assignment record for the driver.
• driverCdls: driverCdls
• driverGid: string
  The driver GID.
• driverTypeGid: string
  This driver's driver type.
• driverXid: string
  The XID for the driver.
• endDate: endDate
  The End Date is the last day/date the driver is available. The shipments' start date and end dates must both fall within the drivers' effective and end date range for an assignment to be feasible, in which case, the driver is assigned to the shipment.
  If the driver assignment itself pushes the end date of the shipment past the drivers' expiration date, it will be allowed.
• firstName: string
  The driver's first name.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isActive: boolean
  Indicate if the driver is active.
• lastName: string
  The driver's last name.
• links: array links
  Read Only: true
• powerUnits: powerUnits
• prefConstraintConfigGid: string
  Holds all the Preferences and Constraints for this Driver as a Logic Configuration group.
• prevSightingDate: prevSightingDate
  Read Only: true

  Previous date of sighting.
• prevSightingLocation: prevSightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• prevSightingLocationGid: string
  Read Only: true

  Previous location of sighting.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• rateDistanceGid: string
  The rate distance at the driver level.
• rateOfferingGid: string
  The rate offering linked to the driver.
• refnums: refnums
• remarks: remarks
• resourceType: string
  This enumerate indicates the employment type of the driver. Values include - E - Employed I - Independent Contractor T - Third Party.
• sightingDate: sightingDate
  Read Only: true

  Date of sighting.
• sightingLocation: sightingLocation
  The location of sighting.
• sightingLocationGid: string
  Read Only: true

  Location of sighting.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• specialServices: specialServices
• statuses: statuses
• texts: texts
• trackingEvents: trackingEvents
• updateDate: updateDate
  Read Only: true

  update date
• useHosHistory: boolean
  This flag indicates if each shipment for this driver should start with fresh HOS regardless of previous history/shipments.
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• workRegionGid: string
  The driver's primary work region.

{
    "properties":{
        "driverGid":{
            "description":"The driver GID.",
            "type":"string"
        },
        "driverXid":{
            "description":"The XID for the driver.",
            "type":"string"
        },
        "defHomeLocGid":{
            "description":"Driver's Home Location ID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "defHomeLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property defHomeLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "firstName":{
            "description":"The driver's first name.",
            "type":"string"
        },
        "lastName":{
            "description":"The driver's last name.",
            "type":"string"
        },
        "dateOfBirth":{
            "description":"The driver's date of birth.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "workRegionGid":{
            "description":"The driver's primary work region.",
            "type":"string"
        },
        "dedAcctLocnProfileGid":{
            "description":"The location profile of the driver's dedicated account.",
            "type":"string"
        },
        "contactGid":{
            "description":"The contact user linked to the driver. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "rateOfferingGid":{
            "description":"The rate offering linked to the driver.",
            "type":"string"
        },
        "prefConstraintConfigGid":{
            "description":"Holds all the Preferences and Constraints for this Driver as a Logic Configuration group.",
            "type":"string"
        },
        "resourceType":{
            "description":"This enumerate indicates the employment type of the driver. Values include - E - Employed I - Independent Contractor T - Third Party.",
            "type":"string"
        },
        "useHosHistory":{
            "description":"This flag indicates if each shipment for this driver should start with fresh HOS regardless of previous history/shipments.",
            "type":"boolean"
        },
        "adjHireDate":{
            "description":"Adjusted hire date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "corporationProfileGid":{
            "description":"The corporations for which this driver works.",
            "type":"string"
        },
        "driverTypeGid":{
            "description":"This driver's driver type.",
            "type":"string"
        },
        "isActive":{
            "description":"Indicate if the driver is active.",
            "type":"boolean"
        },
        "sightingLocationGid":{
            "description":"Location of sighting. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "sightingLocation":{
            "description":"The location of sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ]
        },
        "sightingDate":{
            "description":"Date of sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "prevSightingLocationGid":{
            "description":"Previous location of sighting. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "prevSightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevSightingDate":{
            "description":"Previous date of sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "driverAssignmentSeqNum":{
            "description":"Reflects the latest Driver Assignment record for the driver.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "rateDistanceGid":{
            "description":"The rate distance at the driver level.",
            "type":"string"
        },
        "endDate":{
            "description":"The End Date is the last day/date the driver is available. The shipments' start date and end dates must both fall within the drivers' effective and end date range for an assignment to be feasible, in which case, the driver is assigned to the shipment.<br>If the driver assignment itself pushes the end date of the shipment past the drivers' expiration date, it will be allowed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "calendars":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.calendars"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "driverCdls":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.driverCdls"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "assignments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.assignments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "calendarEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.calendarEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "powerUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.powerUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "trackingEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.trackingEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/drivers.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : adjHireDate

Adjusted hire date.

Match All

Adjusted hire date.

Show Source

• object dateType

{
    "description":"Adjusted hire date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : assignments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.assignments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : calendarEvents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.calendarEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : calendars

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.calendars"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : dateOfBirth

The driver's date of birth.

Match All

The driver's date of birth.

Show Source

• object dateType

{
    "description":"The driver's date of birth.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : defHomeLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property defHomeLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property defHomeLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property defHomeLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : driverCdls

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.driverCdls"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : endDate

The End Date is the last day/date the driver is available. The shipments' start date and end dates must both fall within the drivers' effective and end date range for an assignment to be feasible, in which case, the driver is assigned to the shipment.
If the driver assignment itself pushes the end date of the shipment past the drivers' expiration date, it will be allowed.

Match All

The End Date is the last day/date the driver is available. The shipments' start date and end dates must both fall within the drivers' effective and end date range for an assignment to be feasible, in which case, the driver is assigned to the shipment.
If the driver assignment itself pushes the end date of the shipment past the drivers' expiration date, it will be allowed.

Show Source

• object dateType

{
    "description":"The End Date is the last day/date the driver is available. The shipments' start date and end dates must both fall within the drivers' effective and end date range for an assignment to be feasible, in which case, the driver is assigned to the shipment.<br>If the driver assignment itself pushes the end date of the shipment past the drivers' expiration date, it will be allowed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : powerUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.powerUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : prevSightingDate

Read Only: true

Previous date of sighting.

Match All

Previous date of sighting.

Show Source

• object dateTimeType

{
    "description":"Previous date of sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sightingDate

Read Only: true

Date of sighting.

Match All

Date of sighting.

Show Source

• object dateTimeType

{
    "description":"Date of sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : sightingLocation

The location of sighting.

Match All

The location of sighting.

Show Source

• object locations

{
    "description":"The location of sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ]
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : trackingEvents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.trackingEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.assignments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.assignments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.assignments

Type: object

Show Source

• description: string
  Remarks or comments related to shipment(s) assigned to the driver.
• domainName: string
  Database domain where this data is stored.
• driverAssignmentSeqNo: number (int64)
  Driver assignment sequence number.
• isSystemGenerated: boolean
  Check box indicating whether the shipment assigned was system generated.
• links: array links
  Read Only: true
• nextAvailableLoc: nextAvailableLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property nextAvailableLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• nextAvailableLocGid: string
  The GID for the next available location (NAL) for the driver.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• nextAvailableTime: nextAvailableTime
  The GID for the next available time (NAT) for the driver.
• prevDriverAssignmentSeqNum: number (int64)
  Refers to the previous driver assignment record for the driver.
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  The GID of the shipments assigned to the driver.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "driverAssignmentSeqNo":{
            "description":"Driver assignment sequence number.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"The GID of the shipments assigned to the driver. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "nextAvailableLocGid":{
            "description":"The GID for the next available location (NAL) for the driver. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "nextAvailableLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property nextAvailableLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "nextAvailableTime":{
            "description":"The GID for the next available time (NAT) for the driver.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "prevDriverAssignmentSeqNum":{
            "description":"Refers to the previous driver assignment record for the driver.",
            "type":"number",
            "format":"int64"
        },
        "description":{
            "description":"Remarks or comments related to shipment(s) assigned to the driver.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Check box indicating whether the shipment assigned was system generated.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : nextAvailableLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property nextAvailableLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property nextAvailableLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property nextAvailableLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : nextAvailableTime

The GID for the next available time (NAT) for the driver.

Match All

The GID for the next available time (NAT) for the driver.

Show Source

• object dateTimeType

{
    "description":"The GID for the next available time (NAT) for the driver.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.calendarEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.calendarEvents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.calendarEvents

Type: object

Show Source

• calEventTypeGid: string
  The type of the calendar event.
• domainName: string
  Database domain where this data is stored.
• driverCalEventGid: string
  The driver calendar event GID.
• driverCalEventXid: string
  The XID for the driver calendar event.
• eventEndTime: eventEndTime
  The end time of the activity for this particular driver and event.
• eventLocation: eventLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property eventLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• eventLocationGid: string
  The location where this calendar event is scheduled.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• eventStartTime: eventStartTime
  The Start time of the activity for this particular driver and event.
• links: array links
  Read Only: true

{
    "properties":{
        "driverCalEventGid":{
            "description":"The driver calendar event GID.",
            "type":"string"
        },
        "driverCalEventXid":{
            "description":"The XID for the driver calendar event.",
            "type":"string"
        },
        "eventStartTime":{
            "description":"The Start time of the activity for this particular driver and event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "eventEndTime":{
            "description":"The end time of the activity for this particular driver and event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "eventLocationGid":{
            "description":"The location where this calendar event is scheduled. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "eventLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property eventLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "calEventTypeGid":{
            "description":"The type of the calendar event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventEndTime

The end time of the activity for this particular driver and event.

Match All

The end time of the activity for this particular driver and event.

Show Source

• object dateTimeType

{
    "description":"The end time of the activity for this particular driver and event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : eventLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property eventLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property eventLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property eventLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : eventStartTime

The Start time of the activity for this particular driver and event.

Match All

The Start time of the activity for this particular driver and event.

Show Source

• object dateTimeType

{
    "description":"The Start time of the activity for this particular driver and event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.calendars

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.calendars"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.calendars

Type: object

Show Source

• activityCalendar: activityCalendar
  Activity Calendar.
• activityCalendarGid: string
  The activity calendar of the driver defined for this work profile.
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for this driver work profile.
• expiryDate: expiryDate
  The expiry date for this driver work profile.
• homeLocation: homeLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property homeLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• homeLocationGid: string
  The home location of the driver defined for this work profile.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• isShiftBased: string
  Allows you to select whether the work profile for the driver is Shift Based or not. If you set this to Yes, then the work profile is evaluated when you try and get the driver home. The driver will be sent home at the end of each shift, and they will start from their home location for their next assignment.
• links: array links
  Read Only: true

{
    "properties":{
        "homeLocationGid":{
            "description":"The home location of the driver defined for this work profile. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "homeLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property homeLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "activityCalendarGid":{
            "description":"The activity calendar of the driver defined for this work profile.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date for this driver work profile.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expiryDate":{
            "description":"The expiry date for this driver work profile.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isShiftBased":{
            "description":"Allows you to select whether the work profile for the driver is Shift Based or not. If you set this to Yes, then the work profile is evaluated when you try and get the driver home. The driver will be sent home at the end of each shift, and they will start from their home location for their next assignment.",
            "type":"string"
        },
        "activityCalendar":{
            "description":"Activity Calendar.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/calendars"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityCalendar

Activity Calendar.

Match All

Activity Calendar.

Show Source

• object calendars

{
    "description":"Activity Calendar.",
    "allOf":[
        {
            "$ref":"#/components/schemas/calendars"
        }
    ]
}

Nested Schema : effectiveDate

The effective date for this driver work profile.

Match All

The effective date for this driver work profile.

Show Source

• object dateType

{
    "description":"The effective date for this driver work profile.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expiryDate

The expiry date for this driver work profile.

Match All

The expiry date for this driver work profile.

Show Source

• object dateType

{
    "description":"The expiry date for this driver work profile.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : homeLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property homeLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property homeLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property homeLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : calendars

Type: object

Show Source

• calendarGid: string
  CALENDAR_GID is the unique identifier for a calendar.
• calendarName: string
  CALENDAR_NAME is text that describes the purpose of the calendar. Examples include: office hours, summer calendar, pickup, etc.
• calendarXid: string
  CALENDAR_XID is the unique external identifier for a calendar.
• daysInCycle: number (int32)
  DAYS_IN_CYLCE specifies the number of days for which this calendar is in effect.
• details: details
• domainName: string
  No description.
• holidayProfileGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• notes: string
  NOTES contains text that describes additional information about the calendar. Examples include: "ALL THE TIME," "CAL_ANNUAL," "OFFICE HOURS - 8AM TO 6PM," etc.
• startDate: startDate
  START_DATE contains the effective date of the calendar.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "calendarGid":{
            "description":"CALENDAR_GID is the unique identifier for a calendar.",
            "type":"string"
        },
        "calendarXid":{
            "description":"CALENDAR_XID is the unique external identifier for a calendar.",
            "type":"string"
        },
        "calendarName":{
            "description":"CALENDAR_NAME is text that describes the purpose of the calendar. Examples include: office hours, summer calendar, pickup, etc.",
            "type":"string"
        },
        "startDate":{
            "description":"START_DATE contains the effective date of the calendar.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "daysInCycle":{
            "description":"DAYS_IN_CYLCE specifies the number of days for which this calendar is in effect.",
            "type":"number",
            "format":"int32"
        },
        "holidayProfileGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "notes":{
            "description":"NOTES contains text that describes additional information about the calendar. Examples include: \"ALL THE TIME,\" \"CAL_ANNUAL,\" \"OFFICE HOURS - 8AM TO 6PM,\" etc.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/calendars.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/calendars.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : startDate

START_DATE contains the effective date of the calendar.

Match All

START_DATE contains the effective date of the calendar.

Show Source

• object dateTimeType

{
    "description":"START_DATE contains the effective date of the calendar.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object calendars.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/calendars.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : calendars.details

Type: object

Show Source

• activityCalendarId: number (int64)
  ACTIVITY_CALENDAR_ID is the system-generated unique ID for ACTIVITY_CALENDAR. (IDs are internal system indexes; therefore, they are usually not recognizable to users.)
• activityGid: string
  ACTIVITY_GID is the unique identifier of an activity. This entry defines an activity with the time(s) when that activity can occur.
• activityTimeFactor: number (double)
  Acitivity factor provides a multiplication factor for the activity.
• begin: number (int64)
  BEGIN contains the time when an activity can start.
• domainName: string
  No description.
• duration: number (int64)
  DURATION contains the length of time an activity can take place.
• isWorkOn: boolean
  IS_WORK_ON is a flag describing whether a specific activity calendar is active. (Valid values are Y for yes (the calendar is active) or N for no (the calendar is not active).
• links: array links
  Read Only: true

{
    "properties":{
        "activityCalendarId":{
            "description":"ACTIVITY_CALENDAR_ID is the system-generated unique ID for ACTIVITY_CALENDAR. (IDs are internal system indexes; therefore, they are usually not recognizable to users.)",
            "type":"number",
            "format":"int64"
        },
        "activityGid":{
            "description":"ACTIVITY_GID is the unique identifier of an activity. This entry defines an activity with the time(s) when that activity can occur.",
            "type":"string"
        },
        "isWorkOn":{
            "description":"IS_WORK_ON is a flag describing whether a specific activity calendar is active. (Valid values are Y for yes (the calendar is active) or N for no (the calendar is not active).",
            "type":"boolean"
        },
        "begin":{
            "description":"BEGIN contains the time when an activity can start.",
            "type":"number",
            "format":"int64"
        },
        "duration":{
            "description":"DURATION contains the length of time an activity can take place.",
            "type":"number",
            "format":"int64"
        },
        "activityTimeFactor":{
            "description":"Acitivity factor provides a multiplication factor for the activity.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.driverCdls

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.driverCdls"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.driverCdls

Type: object

Show Source

• cdlClass: string
  The commercial driving license class type.
• cdlExpDate: cdlExpDate
  The expiration date of the commercial driving license.
• cdlIssueCountryGid: string
  The country which issued the commercial driving license.
• cdlIssueState: string
  The state that issued the commercial driving license.
• cdlNum: string
  The unique commercial driving license number.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "cdlNum":{
            "description":"The unique commercial driving license number.",
            "type":"string"
        },
        "cdlClass":{
            "description":"The commercial driving license class type.",
            "type":"string"
        },
        "cdlIssueState":{
            "description":"The state that issued the commercial driving license.",
            "type":"string"
        },
        "cdlIssueCountryGid":{
            "description":"The country which issued the commercial driving license.",
            "type":"string"
        },
        "cdlExpDate":{
            "description":"The expiration date of the commercial driving license.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cdlExpDate

The expiration date of the commercial driving license.

Match All

The expiration date of the commercial driving license.

Show Source

• object dateType

{
    "description":"The expiration date of the commercial driving license.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.involvedParties

Type: object

Show Source

• comMethodGid: string
  The GID for the communication method for the involved party contact associated with the driver.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The GID for the involved party contact associated with the driver.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The GID for the involved party contact qualifier associated with the driver.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for the involved party contact qualifier associated with the driver.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The GID for the involved party contact associated with the driver. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The GID for the communication method for the involved party contact associated with the driver.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.powerUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.powerUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.powerUnits

Type: object

Show Source

• calendarGid: string
  The GID for the calendar that determines the day and times when the power unit can be used with the driver. For example, if you select a calendar for Monday through Friday, 8 a.m.-8 p.m., that power unit would be used with that driver Monday through Friday, 8 a.m.-8 p.m.. On a different driver you could then select a time of Monday through Friday, 8 p.m. -8 a.m., as well as on any time on Saturday and Sunday, and assign the same power unit to a different driver. Only calendars with an activity of Driver Work will be considered for overlap when other drivers share the same power unit. Validation checks against other calendars for duplicate assignments when you save. By establishing power unit availability to multiple drivers through the use of a calendar, you are defining "slip seating".
• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date for this Driver and Power Unit union.
• expirationDate: expirationDate
  The expiration date for this Driver and Power Unit union.
• links: array links
  Read Only: true
• powerUnit: powerUnit
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• powerUnitGid: string
  The power unit assigned to the driver.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sequence: number (int64)
  Primary key of the table.

{
    "properties":{
        "sequence":{
            "description":"Primary key of the table.",
            "type":"number",
            "format":"int64"
        },
        "powerUnitGid":{
            "description":"The power unit assigned to the driver. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "powerUnit":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/powerUnits"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"The effective date for this Driver and Power Unit union.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date for this Driver and Power Unit union.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "calendarGid":{
            "description":"The GID for the calendar that determines the day and times when the power unit can be used with the driver. For example, if you select a calendar for Monday through Friday, 8 a.m.-8 p.m., that power unit would be used with that driver Monday through Friday, 8 a.m.-8 p.m.. On a different driver you could then select a time of Monday through Friday, 8 p.m. -8 a.m., as well as on any time on Saturday and Sunday, and assign the same power unit to a different driver. Only calendars with an activity of Driver Work will be considered for overlap when other drivers share the same power unit. Validation checks against other calendars for duplicate assignments when you save. By establishing power unit availability to multiple drivers through the use of a calendar, you are defining \"slip seating\".",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date for this Driver and Power Unit union.

Match All

The effective date for this Driver and Power Unit union.

Show Source

• object dateTimeType

{
    "description":"The effective date for this Driver and Power Unit union.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date for this Driver and Power Unit union.

Match All

The expiration date for this Driver and Power Unit union.

Show Source

• object dateTimeType

{
    "description":"The expiration date for this Driver and Power Unit union.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : powerUnit

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/powerUnits"
        }
    ],
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• corporation: corporation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• corporationGid: string
  The GID for the owning corporation for the power unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dateBuilt: dateBuilt
  The date the power unit was built.
• description: string
  The description field associated with the power unit.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• domicileCountryCodeGid: string
  The country the power unit was originally from.
• equipments: equipments
• insertDate: insertDate
  Read Only: true

  insert date
• isActive: boolean
  A Y/N indicator field designating if the power unit is active.
• links: array links
  Read Only: true
• parkLocation: parkLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parkLocationGid: string
  The location GID where the power unit is appointed to park.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• powerUnitGid: string
  The GID for the power unit.
• powerUnitNum: string
  A unique number associated with the power unit.
• powerUnitTypeGid: string
  The type GID associated with the power unit type.
• powerUnitXid: string
  The XID for the power unit.
• prevSightingDate: prevSightingDate
  Read Only: true

  The date associated with the tracking message for the previous sighting location.
• prevSightingLocation: prevSightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• prevSightingLocationGid: string
  Read Only: true

  The previous location sighting GID from the track and trace messages matched to the power unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• pullingLength: pullingLength
  Determines the overall length of power unit/trailer. Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.
• refnums: refnums
• remarks: remarks
• sightingDate: sightingDate
  Read Only: true

  The date associated with the tracking message for the sighting location.
• sightingLocation: sightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sightingLocationGid: string
  Read Only: true

  The latest location sighting GID from the track and trace messages matched to the power unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• specialServices: specialServices
• statuses: statuses
• tareWeight: tareWeight
  The tare weight of the power unit.
• texts: texts
• trackingEvents: trackingEvents
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.
• userDefined2IconGid: string
  A user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.
• userDefined3IconGid: string
  A user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.
• userDefined4IconGid: string
  A user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.
• userDefined5IconGid: string
  A user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.

{
    "properties":{
        "powerUnitGid":{
            "description":"The GID for the power unit.",
            "type":"string"
        },
        "powerUnitXid":{
            "description":"The XID for the power unit.",
            "type":"string"
        },
        "description":{
            "description":"The description field associated with the power unit.",
            "type":"string"
        },
        "powerUnitNum":{
            "description":"A unique number associated with the power unit.",
            "type":"string"
        },
        "dateBuilt":{
            "description":"The date the power unit was built.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domicileCountryCodeGid":{
            "description":"The country the power unit was originally from.",
            "type":"string"
        },
        "corporationGid":{
            "description":"The GID for the owning corporation for the power unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "corporation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/corporations"
                }
            ],
            "readOnly":true
        },
        "parkLocationGid":{
            "description":"The location GID where the power unit is appointed to park. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parkLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "powerUnitTypeGid":{
            "description":"The type GID associated with the power unit type.",
            "type":"string"
        },
        "tareWeight":{
            "description":"The tare weight of the power unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isActive":{
            "description":"A Y/N indicator field designating if the power unit is active.",
            "type":"boolean"
        },
        "sightingLocationGid":{
            "description":"The latest location sighting GID from the track and trace messages matched to the power unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "sightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sightingDate":{
            "description":"The date associated with the tracking message for the sighting location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "prevSightingLocationGid":{
            "description":"The previous location sighting GID from the track and trace messages matched to the power unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "prevSightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevSightingDate":{
            "description":"The date associated with the tracking message for the previous sighting location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"A user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"A user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"A user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"A user-defined icon that will appear within the user interface to help visually identify attributes of the power unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "pullingLength":{
            "description":"Determines the overall length of power unit/trailer. Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/powerUnits.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/powerUnits.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/powerUnits.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/powerUnits.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/powerUnits.equipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/powerUnits.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "trackingEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/powerUnits.trackingEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/powerUnits.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : corporation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property corporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/corporations"
        }
    ],
    "readOnly":true
}

Nested Schema : dateBuilt

The date the power unit was built.

Match All

The date the power unit was built.

Show Source

• object dateType

{
    "description":"The date the power unit was built.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/powerUnits.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/powerUnits.equipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : parkLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingDate

Read Only: true

The date associated with the tracking message for the previous sighting location.

Match All

The date associated with the tracking message for the previous sighting location.

Show Source

• object dateTimeType

{
    "description":"The date associated with the tracking message for the previous sighting location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : pullingLength

Determines the overall length of power unit/trailer. Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.

Match All

Determines the overall length of power unit/trailer. Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.

Show Source

• object amountType

{
    "description":"Determines the overall length of power unit/trailer. Interpreted as the length from the king pin to the rear of the trailer for Semi-Trailer Truck Type. Interpreted as the length from the hitch to the rear of the trailer for Pony-Trailer Truck Type. Interpreted as the length from the front of the vehicle to the hitch for the Dromedary Truck Type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/powerUnits.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/powerUnits.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sightingDate

Read Only: true

The date associated with the tracking message for the sighting location.

Match All

The date associated with the tracking message for the sighting location.

Show Source

• object dateTimeType

{
    "description":"The date associated with the tracking message for the sighting location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : sightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/powerUnits.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/powerUnits.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tareWeight

The tare weight of the power unit.

Match All

The tare weight of the power unit.

Show Source

• object amountType

{
    "description":"The tare weight of the power unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/powerUnits.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : trackingEvents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/powerUnits.trackingEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object powerUnits.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/powerUnits.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : powerUnits.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/powerUnits.equipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this association with the power unit and equipment.
• equipment: equipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGid: string
  The GID for the equipment defined for the power unit and equipment (trailer) association.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• expirationDate: expirationDate
  The expiration date of this association with the power unit and equipment.
• links: array links
  Read Only: true
• powerUnitEquipmentSeq: number (int64)
  The sequence (key) associated with the power unit and equipment (trailer) join.

{
    "properties":{
        "powerUnitEquipmentSeq":{
            "description":"The sequence (key) associated with the power unit and equipment (trailer) join.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "equipmentGid":{
            "description":"The GID for the equipment defined for the power unit and equipment (trailer) association. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipments"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"The effective date of this association with the power unit and equipment. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this association with the power unit and equipment. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this association with the power unit and equipment.

Match All

The effective date of this association with the power unit and equipment.

Show Source

• object dateTimeType

{
    "description":"The effective date of this association with the power unit and equipment. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipments"
        }
    ],
    "readOnly":true
}

Nested Schema : expirationDate

The expiration date of this association with the power unit and equipment.

Match All

The expiration date of this association with the power unit and equipment.

Show Source

• object dateTimeType

{
    "description":"The expiration date of this association with the power unit and equipment. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• aarCarType: string
  The Association of American Railroads Car Type.
• aarMechDesig: string
  AAR Mechanical Designation.
• arriveDate: arriveDate
  Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.
• assignedProduct: string
  N/A
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• carDestinationEtaDate: carDestinationEtaDate
  This is the estimated arrival time at the car destination.
• carDestinationLocation: carDestinationLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• carDestinationLocationGid: string
  Specifies destination for the car.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• currentChassisInitial: string
  Initial of the current chassis.
• currentChassisNumber: string
  Number of the current chassis.
• customerFleet: string
  This is a more granular field for the organization to specify the customer assignment as the customer wishes. It will identify product, location, customer, or any combination.
• dateBuilt: dateBuilt
  The date this equipment was built.
• divisionName: string
  This is the Business Division name field for part of the organization that is responsible for the asset and the business.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• dryCapacity: dryCapacity
  The maximum interior capacity of the equipment.
• emptyCgHeight: emptyCgHeight
  When empty, indicates the height from Top of Rail to the Center of Gravity.
• emptyCgLength: emptyCgLength
  When empty, length wise position of center of gravity from the equipment bottom leftmost corner.
• emptyCgWidth: emptyCgWidth
  When empty, width wise position of center of gravity from the equipment bottom leftmost corner.
• equipMaxGrossWt: equipMaxGrossWt
  The maximum permissible weight of the equipment and the load.
• equipmentGid: string
  The GID for equipment.
• equipmentInitial: string
  Typically this is a prefix or alphanumeric combination associated with the carrier Standard Carrier Alpha Code (SCAC) for the equipment.
• equipmentInitialNumber: string
  Equipment Initial and Number is a concatenation of the equipment initial and equipment number.
• equipmentName: string
  Text to describe the type of equipment. Examples include: CAR LOADS, TANKER, TRUCKS
• equipmentNumber: string
  The number assigned to the equipment and is entered to associate the number with the equipment initial.
• equipmentOwnerType: string
  The Type of Owner for this Equipment. C = Carrier Owned, L = Lessee, P = Private, A = All
• equipmentType: equipmentType
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentTypeGid: string
  The GID for the equipment type.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentXid: string
  The XID for the equipment type.
• floorHeight: floorHeight
  Actual height of the platform or floor above the ground or the rail.
• insertDate: insertDate
  Read Only: true

  insert date
• interchangeRecvDate: interchangeRecvDate
  Time of the interchange receive.
• interchangeRecvLocation: interchangeRecvLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• interchangeRecvLocationGid: string
  Interchange receive location of the equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• isContainer: boolean
  Yes/No indicator for whether the equipment is a container.
• lastIngateTime: lastIngateTime
  Ingate time stamp at the inbound ramp.
• lastOutgateLocation: lastOutgateLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• lastOutgateLocationGid: string
  The location where the equipment (chassis/container or trailer) was last outgated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• lastOutgateTime: lastOutgateTime
  Outgate time stamp at the outbound ramp.
• lesseeGid: string
  The SCAC for the Lessee of the Equipment.
• licensePlate: string
  The license plate number.
• licenseState: string
  The license state.
• links: array links
  Read Only: true
• liquidCapacity: liquidCapacity
  The number of gallons the equipment will hold.
• loadOrEmpty: string
  Indicates whether the equipment is Load or Empty or Unknown (default)
• maxAxleWeight: maxAxleWeight
  Maximum allowed axle weight. Applicable only to rail cars.
• orderCustomerName: string
  This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the consignee.
• orderDestination: string
  This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the city and state.
• orderSource: string
  This is a customer determined field based on an agent action. Most likely the customer will populate an abbreviated version of the city and state.
• ownerName: string
  Text for the name of the equipment owner.
• ownershipCode: string
  Alpha-numeric code designating the status of the equipment (for example, leased or owned).
• parkLocation: parkLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parkLocationGid: string
  Park location of the equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• prevReportingRrScac: string
  This is the previous Reporting SCAC. The UPDATE ACTION moves the current value to the previous value before overwriting the current value.
• prevSightingDate: prevSightingDate
  Time of the previous sighting.
• prevSightingEvtScGid: string
  Previous sighting event represents the previous status code of the equipment.
• prevSightingLocation: prevSightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• prevSightingLocationGid: string
  Previous sighting location of the equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• purchDate: purchDate
  The purchase date of this equipment.
• refnums: refnums
• registrationDate: registrationDate
  The date of the registration.
• registrationNum: string
  Registration number.
• releaseDate: releaseDate
  Every time a car is released, this field is updated by a customer controlled agent action. It is used to dynamically calculate in-transit time.
• remarks: remarks
• reportingRrScac: string
  This is to report the Railroad Reporting SCAC code that provided the last event. It is copied in an agent action called UPDATE SIGHTING.
• sightingDate: sightingDate
  Time of the sighting.
• sightingEvtScGid: string
  Sighting event represents the current status code of the equipment.
• sightingLocation: sightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sightingLocationGid: string
  Sighting location of the equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• specialServices: specialServices
• statuses: statuses
• tag1: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag2: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag3: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tag4: string
  Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.
• tareWeight: tareWeight
  The empty weight of the equipment by itself.
• texts: texts
• totalAxleCount: number (int32)
  The total number of axles on the equipment. Applicable only to rail cars.
• trackingEvents: trackingEvents
• truckCenterLength: truckCenterLength
  The length between the centers of the two truck/bogie systems. Applicable only to rail cars.
• truckCount: number (int32)
  The total number of trucks/bogies on the equipment. Applicable only to rail cars.
• umCharge: umCharge
  UMLER Mileage Charge.
• umChargeUnit: umChargeUnit
  UMLER Mileage Charge Unit (example, 2).
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.

{
    "properties":{
        "equipmentGid":{
            "description":"The GID for equipment.",
            "type":"string"
        },
        "equipmentXid":{
            "description":"The XID for the equipment type.",
            "type":"string"
        },
        "equipmentName":{
            "description":"Text to describe the type of equipment. Examples include: CAR LOADS, TANKER, TRUCKS",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"The GID for the equipment type. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentType":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentTypes"
                }
            ],
            "readOnly":true
        },
        "equipmentInitial":{
            "description":"Typically this is a prefix or alphanumeric combination associated with the carrier Standard Carrier Alpha Code (SCAC) for the equipment.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The number assigned to the equipment and is entered to associate the number with the equipment initial.",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"Equipment Initial and Number is a concatenation of the equipment initial and equipment number. ",
            "type":"string"
        },
        "ownershipCode":{
            "description":"Alpha-numeric code designating the status of the equipment (for example, leased or owned).",
            "type":"string"
        },
        "ownerName":{
            "description":"Text for the name of the equipment owner.",
            "type":"string"
        },
        "tag1":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag2":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag3":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "tag4":{
            "description":"Tag fields, like attribute fields, are available to store additional information associated with this piece of equipment.",
            "type":"string"
        },
        "equipmentOwnerType":{
            "description":"The Type of Owner for this Equipment. C = Carrier Owned, L = Lessee, P = Private, A = All",
            "type":"string"
        },
        "lesseeGid":{
            "description":"The SCAC for the Lessee of the Equipment.",
            "type":"string"
        },
        "tareWeight":{
            "description":"The empty weight of the equipment by itself.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aarCarType":{
            "description":"The Association of American Railroads Car Type.",
            "type":"string"
        },
        "dateBuilt":{
            "description":"The date this equipment was built.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "purchDate":{
            "description":"The purchase date of this equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "registrationNum":{
            "description":"Registration number.",
            "type":"string"
        },
        "registrationDate":{
            "description":"The date of the registration.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "licensePlate":{
            "description":"The license plate number.",
            "type":"string"
        },
        "licenseState":{
            "description":"The license state.",
            "type":"string"
        },
        "sightingLocationGid":{
            "description":"Sighting location of the equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sightingDate":{
            "description":"Time of the sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "prevSightingLocationGid":{
            "description":"Previous sighting location of the equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "prevSightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevSightingDate":{
            "description":"Time of the previous sighting.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "interchangeRecvLocationGid":{
            "description":"Interchange receive location of the equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "interchangeRecvLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "interchangeRecvDate":{
            "description":"Time of the interchange receive.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five User-Defined Image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "isContainer":{
            "description":"Yes/No indicator for whether the equipment is a container.",
            "type":"boolean"
        },
        "currentChassisInitial":{
            "description":"Initial of the current chassis.",
            "type":"string"
        },
        "currentChassisNumber":{
            "description":"Number of the current chassis.",
            "type":"string"
        },
        "lastOutgateLocationGid":{
            "description":"The location where the equipment (chassis/container or trailer) was last outgated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "lastOutgateLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "lastOutgateTime":{
            "description":"Outgate time stamp at the outbound ramp.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastIngateTime":{
            "description":"Ingate time stamp at the inbound ramp.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "parkLocationGid":{
            "description":"Park location of the equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parkLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "umCharge":{
            "description":"UMLER Mileage Charge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "umChargeUnit":{
            "description":"UMLER Mileage Charge Unit (example, 2).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aarMechDesig":{
            "description":"AAR Mechanical Designation.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "equipMaxGrossWt":{
            "description":"The maximum permissible weight of the equipment and the load.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "floorHeight":{
            "description":"Actual height of the platform or floor above the ground or the rail.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgHeight":{
            "description":"When empty, indicates the height from Top of Rail to the Center of Gravity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "dryCapacity":{
            "description":"The maximum interior capacity of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "liquidCapacity":{
            "description":"The number of gallons the equipment will hold.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "assignedProduct":{
            "description":"N/A",
            "type":"string"
        },
        "carDestinationLocationGid":{
            "description":"Specifies destination for the car. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "carDestinationLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "carDestinationEtaDate":{
            "description":"This is the estimated arrival time at the car destination.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "emptyCgLength":{
            "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgWidth":{
            "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "loadOrEmpty":{
            "description":"Indicates whether the equipment is Load or Empty or Unknown (default)",
            "type":"string"
        },
        "sightingEvtScGid":{
            "description":"Sighting event represents the current status code of the equipment.",
            "type":"string"
        },
        "prevSightingEvtScGid":{
            "description":"Previous sighting event represents the previous status code of the equipment.",
            "type":"string"
        },
        "divisionName":{
            "description":"This is the Business Division name field for part of the organization that is responsible for the asset and the business.",
            "type":"string"
        },
        "customerFleet":{
            "description":"This is a more granular field for the organization to specify the customer assignment as the customer wishes. It will identify product, location, customer, or any combination.",
            "type":"string"
        },
        "reportingRrScac":{
            "description":"This is to report the Railroad Reporting SCAC code that provided the last event. It is copied in an agent action called UPDATE SIGHTING.",
            "type":"string"
        },
        "prevReportingRrScac":{
            "description":"This is the previous Reporting SCAC.  The UPDATE ACTION moves the current value to the previous value before overwriting the current value.",
            "type":"string"
        },
        "releaseDate":{
            "description":"Every time a car is released, this field is updated by a customer controlled agent action.  It is used to dynamically calculate in-transit time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "arriveDate":{
            "description":"Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "orderSource":{
            "description":"This is a customer determined field based on an agent action.  Most likely the customer will populate an abbreviated version of the city and state.",
            "type":"string"
        },
        "orderDestination":{
            "description":"This is a customer determined field based on an agent action.  Most likely the customer will populate an abbreviated version of the city and state.",
            "type":"string"
        },
        "orderCustomerName":{
            "description":"This is a customer determined field based on an agent action.  Most likely the customer will populate an abbreviated version of the consignee.",
            "type":"string"
        },
        "truckCenterLength":{
            "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCount":{
            "description":"The total number of trucks/bogies on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "totalAxleCount":{
            "description":"The total number of axles on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "maxAxleWeight":{
            "description":"Maximum allowed axle weight. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "trackingEvents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.trackingEvents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/equipments.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : arriveDate

Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.

Match All

Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.

Show Source

• object dateTimeType

{
    "description":"Every time a car arrives, a customer controlled agent action will populate this. It is used to dynamically calculate the dwell time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : carDestinationEtaDate

This is the estimated arrival time at the car destination.

Match All

This is the estimated arrival time at the car destination.

Show Source

• object dateTimeType

{
    "description":"This is the estimated arrival time at the car destination.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : carDestinationLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property carDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : dateBuilt

The date this equipment was built.

Match All

The date this equipment was built.

Show Source

• object dateType

{
    "description":"The date this equipment was built.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipments.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : dryCapacity

The maximum interior capacity of the equipment.

Match All

The maximum interior capacity of the equipment.

Show Source

• object amountType

{
    "description":"The maximum interior capacity of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgHeight

When empty, indicates the height from Top of Rail to the Center of Gravity.

Match All

When empty, indicates the height from Top of Rail to the Center of Gravity.

Show Source

• object amountType

{
    "description":"When empty, indicates the height from Top of Rail to the Center of Gravity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgLength

When empty, length wise position of center of gravity from the equipment bottom leftmost corner.

Match All

When empty, length wise position of center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, length wise position of center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgWidth

When empty, width wise position of center of gravity from the equipment bottom leftmost corner.

Match All

When empty, width wise position of center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, width wise position of center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipMaxGrossWt

The maximum permissible weight of the equipment and the load.

Match All

The maximum permissible weight of the equipment and the load.

Show Source

• object amountType

{
    "description":"The maximum permissible weight of the equipment and the load.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipmentType

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object equipmentTypes

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentTypes"
        }
    ],
    "readOnly":true
}

Nested Schema : floorHeight

Actual height of the platform or floor above the ground or the rail.

Match All

Actual height of the platform or floor above the ground or the rail.

Show Source

• object amountType

{
    "description":"Actual height of the platform or floor above the ground or the rail.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : interchangeRecvDate

Time of the interchange receive.

Match All

Time of the interchange receive.

Show Source

• object dateTimeType

{
    "description":"Time of the interchange receive.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : interchangeRecvLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property interchangeRecvLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : lastIngateTime

Ingate time stamp at the inbound ramp.

Match All

Ingate time stamp at the inbound ramp.

Show Source

• object dateTimeType

{
    "description":"Ingate time stamp at the inbound ramp.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lastOutgateLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property lastOutgateLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : lastOutgateTime

Outgate time stamp at the outbound ramp.

Match All

Outgate time stamp at the outbound ramp.

Show Source

• object dateTimeType

{
    "description":"Outgate time stamp at the outbound ramp.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : liquidCapacity

The number of gallons the equipment will hold.

Match All

The number of gallons the equipment will hold.

Show Source

• object amountType

{
    "description":"The number of gallons the equipment will hold.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxAxleWeight

Maximum allowed axle weight. Applicable only to rail cars.

Match All

Maximum allowed axle weight. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Maximum allowed axle weight. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : parkLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parkLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingDate

Time of the previous sighting.

Match All

Time of the previous sighting.

Show Source

• object dateTimeType

{
    "description":"Time of the previous sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : prevSightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : purchDate

The purchase date of this equipment.

Match All

The purchase date of this equipment.

Show Source

• object dateType

{
    "description":"The purchase date of this equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipments.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : registrationDate

The date of the registration.

Match All

The date of the registration.

Show Source

• object dateType

{
    "description":"The date of the registration.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : releaseDate

Every time a car is released, this field is updated by a customer controlled agent action. It is used to dynamically calculate in-transit time.

Match All

Every time a car is released, this field is updated by a customer controlled agent action. It is used to dynamically calculate in-transit time.

Show Source

• object dateTimeType

{
    "description":"Every time a car is released, this field is updated by a customer controlled agent action.  It is used to dynamically calculate in-transit time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipments.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sightingDate

Time of the sighting.

Match All

Time of the sighting.

Show Source

• object dateTimeType

{
    "description":"Time of the sighting.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipments.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipments.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tareWeight

The empty weight of the equipment by itself.

Match All

The empty weight of the equipment by itself.

Show Source

• object amountType

{
    "description":"The empty weight of the equipment by itself.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipments.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : trackingEvents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/equipments.trackingEvents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : truckCenterLength

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Match All

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : umCharge

UMLER Mileage Charge.

Match All

UMLER Mileage Charge.

Show Source

• object currencyType

{
    "description":"UMLER Mileage Charge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : umChargeUnit

UMLER Mileage Charge Unit (example, 2).

Match All

UMLER Mileage Charge Unit (example, 2).

Show Source

• object amountType

{
    "description":"UMLER Mileage Charge Unit (example, 2).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipments.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : equipments.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentRefnumQualGid: string
  The equipment reference number qualifier.
• links: array links
  Read Only: true
• refnumValue: string
  The equipment reference number value.

{
    "properties":{
        "equipmentRefnumQualGid":{
            "description":"The equipment reference number qualifier.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The equipment reference number value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The Remark Qualifier ID.
• remarkSequence: number (int64)
  The sequence number of the remark.
• remarkText: string
  The Text of the Remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence number of the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The Remark Qualifier ID.",
            "type":"string"
        },
        "remarkText":{
            "description":"The Text of the Remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this special service.
• expirationDate: expirationDate
  The expiration date of this special service.
• links: array links
  Read Only: true
• specialServiceGid: string
  The GID for the special services being assigned to the equipment.

{
    "properties":{
        "specialServiceGid":{
            "description":"The GID for the special services being assigned to the equipment.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date of this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this special service.

Match All

The effective date of this special service.

Show Source

• object dateType

{
    "description":"The effective date of this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date of this special service.

Match All

The expiration date of this special service.

Show Source

• object dateType

{
    "description":"The expiration date of this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  Status type for the equipment status.
• statusValueGid: string
  Value of status type

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the equipment status.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  The GID of the document that should hold the text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for the text template related to equipment, The selected template is used with the text override option to populate the remark text.

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template related to equipment, The selected template is used with the text override option to populate the remark text.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"The GID of the document that should hold the text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object equipments.trackingEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/equipments.trackingEvents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : equipments.trackingEvents

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• iTransactionNo: number (int64)
  The transaction identifier linked to the equipment.
• links: array links
  Read Only: true
• partitionKey: number (double)
  The monthly range partition to manage purging status messages.

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier linked to the equipment.",
            "type":"number",
            "format":"int64"
        },
        "partitionKey":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/powerUnits.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• powerUnitRefnumQualGid: string
  The reference qualifier GID defining the reference code.
• powerUnitRefnumValue: string
  The value associated to the reference code.

{
    "properties":{
        "powerUnitRefnumQualGid":{
            "description":"The reference qualifier GID defining the reference  code.",
            "type":"string"
        },
        "powerUnitRefnumValue":{
            "description":"The value associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/powerUnits.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type. For example: insurance number or maintenance codes.
• remarkSequence: number (int64)
  The sequence (key) for the remark.
• remarkText: string
  User-entered remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence (key) for the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: insurance number or maintenance codes.",
            "type":"string"
        },
        "remarkText":{
            "description":"User-entered remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/powerUnits.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this special service associated with the power unit.
• expirationDate: expirationDate
  The expiration date of this special service associated with the power unit.
• links: array links
  Read Only: true
• specialServiceGid: string
  The special service code identifier defining the service required.

{
    "properties":{
        "specialServiceGid":{
            "description":"The special service code identifier defining the service required.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date of this special service associated with the power unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this special service associated with the power unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this special service associated with the power unit.

Match All

The effective date of this special service associated with the power unit.

Show Source

• object dateType

{
    "description":"The effective date of this special service associated with the power unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date of this special service associated with the power unit.

Match All

The expiration date of this special service associated with the power unit.

Show Source

• object dateType

{
    "description":"The expiration date of this special service associated with the power unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/powerUnits.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type GID for the status value on the power unit.
• statusValueGid: string
  The status value for the power unit.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type GID for the status value on the power unit.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the power unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/powerUnits.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  Document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for the text template. A text template is a predefined, formatted selection of text that is identified by a business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template. A text template is a predefined, formatted selection of text that is identified by a business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object powerUnits.trackingEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/powerUnits.trackingEvents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : powerUnits.trackingEvents

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• iTransactionNo: number (int64)
  Transaction identifier linked to the power unit.
• links: array links
  Read Only: true
• partitionKey: number (double)
  The monthly range partition to manage purging status messages.

{
    "properties":{
        "iTransactionNo":{
            "description":"Transaction identifier linked to the power unit.",
            "type":"number",
            "format":"int64"
        },
        "partitionKey":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• driverRefnumQualGid: string
  The driver reference number qualifier GID.
• driverRefnumValue: string
  The value for the driver reference number qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "driverRefnumQualGid":{
            "description":"The driver reference number qualifier GID.",
            "type":"string"
        },
        "driverRefnumValue":{
            "description":"The value for the driver reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier.
• remarkSequence: number (int64)
  The remark sequence number for remarks being added for the driver.
• remarkText: string
  Remark text.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence number for remarks being added for the driver.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• effectiveDate: effectiveDate
  The effective date of this special service for this driver.
• expirationDate: expirationDate
  The expiration date of this special service for this driver
• links: array links
  Read Only: true
• payableIndicatorGid: string
  Allows overriding the payable indicator for a special service for a particular driver.
• specialServiceGid: string
  The expiration date of this special service for this driver.

{
    "properties":{
        "specialServiceGid":{
            "description":"The expiration date of this special service for this driver.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"The effective date of this special service for this driver.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of this special service for this driver",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "payableIndicatorGid":{
            "description":"Allows overriding the payable indicator for a special service for a particular driver.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of this special service for this driver.

Match All

The effective date of this special service for this driver.

Show Source

• object dateType

{
    "description":"The effective date of this special service for this driver.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

The expiration date of this special service for this driver

Match All

The expiration date of this special service for this driver

Show Source

• object dateType

{
    "description":"The expiration date of this special service for this driver",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  Status type for the driver status.
• statusValueGid: string
  Value of status type.

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for the driver status.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.texts

Type: object

Show Source

• documentDefGid: string
  Document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for the text template related to driver. The selected template is used with the text override option to populate the remark text.

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template related to driver. The selected template is used with the text override option to populate the remark text.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.trackingEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.trackingEvents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : drivers.trackingEvents

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• iTransactionNo: number (int64)
  The transaction identifier linked to the driver.
• links: array links
  Read Only: true
• partitionKey: number (double)
  The monthly range partition to manage purging status messages.

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier linked to the driver.",
            "type":"number",
            "format":"int64"
        },
        "partitionKey":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.shipments.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.shipments.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.shipments.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentRefnumQualGid: string
  The reference qualifier GID defining the reference code.
• shipmentRefnumValue: string
  The value associated to the reference code.

{
    "properties":{
        "shipmentRefnumQualGid":{
            "description":"The reference qualifier GID defining the reference  code.",
            "type":"string"
        },
        "shipmentRefnumValue":{
            "description":"The value associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The GID for the status type for the voucher.
• statusValueGid: string
  The GID for status value for the voucher.

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the status type for the voucher.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The GID for status value for the voucher.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object vouchers.vatAnalyses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/vouchers.vatAnalyses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vouchers.vatAnalyses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• links: array links
  Read Only: true
• taxAmount: taxAmount
  The tax amount.
• vatCodeGid: string
  The GID for the Value Added Tax Code.
• vatRate: number (double)
  The Tax Rate that was a applied.

{
    "properties":{
        "vatCodeGid":{
            "description":"The GID for the Value Added Tax Code.",
            "type":"string"
        },
        "taxAmount":{
            "description":"The tax amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "vatRate":{
            "description":"The Tax Rate that was a applied.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : taxAmount

The tax amount.

Match All

The tax amount.

Show Source

• object currencyType

{
    "description":"The tax amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.containerGroups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• containerGroupGid: string
  The GID for the container group.
• containerGroupXid: string
  The XID for the container group.
• containerReleaseNumber: string
  The container release number is assigned once a sea carrier receives a new booking line item. They return the container release number (CRN) corresponding to the new booking.
• destuffLocation: destuffLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destuffLocationGid: string
  The location where the contents will be unloaded (destuffed) from the container.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• details: details
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• referenceCode: string
  This field is populated with the reference code that was entered on the unitization rule that was used to create this container.
• stuffLocation: stuffLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• stuffLocationGid: string
  The location where the contents will be loaded (stuffed) into the container.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• unitizationRequestType: string
  The unitization request type for this container group that can accept orders with the same unitization request flag and the same stuffing and destuffing location.

{
    "properties":{
        "containerGroupGid":{
            "description":"The GID for the container group.",
            "type":"string"
        },
        "containerGroupXid":{
            "description":"The XID for the container group.",
            "type":"string"
        },
        "unitizationRequestType":{
            "description":"The unitization request type for this container group that can accept orders with the same unitization request flag and the same stuffing and destuffing location.",
            "type":"string"
        },
        "containerReleaseNumber":{
            "description":"The container release number is assigned once a sea carrier receives a new booking line item. They return the container release number (CRN) corresponding to the new booking.",
            "type":"string"
        },
        "stuffLocationGid":{
            "description":"The location where the contents will be loaded (stuffed) into the container. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "stuffLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destuffLocationGid":{
            "description":"The location where the contents will be unloaded (destuffed) from the container. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destuffLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "referenceCode":{
            "description":"This field is populated with the reference code that was entered on the unitization rule that was used to create this container.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.containerGroups.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : destuffLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.containerGroups.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : stuffLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property stuffLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.containerGroups.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• sEquipment: sEquipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sEquipmentGid: string
  The GID for the equipment instance on a shipment for this container group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "sEquipmentGid":{
            "description":"The GID for the equipment instance on a shipment for this container group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sEquipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sEquipments"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sEquipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object sEquipments

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sEquipments"
        }
    ],
    "readOnly":true
}

Nested Schema : sEquipments

Type: object

Show Source

• actualHeight: actualHeight
  The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.
• actualLength: actualLength
  The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.
• actualLoadLimit: actualLoadLimit
  The maximum permissible weight of the commodity that can be loaded into the equipment.
• actualWidth: actualWidth
  The inside width of the actual equipment from side walls and linings.
• assignmentCode: string
  The assignment code (view only) indicates how the equipment was assigned.
• attributes: attributes
• axleWeightImbalance: number (double)
  Denotes the ratio between the calculated axles weights.Applicable only to rail cars.
• calculatedGrossWt: calculatedGrossWt
  The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight.
• checkDigit: number (int32)
  The Check Digit field is used to validate that the Equipment Initial/Number field is entered correctly. You can leave this field blank if you do not want to validate Equipment Initial/Number. The ISO 6346 for ocean containers is used to verify the check digit value
• domainName: string
  Database domain where this data is stored.
• dropSkuGid: string
  With the DROP_SKU_QUANTITY_TYPE_GID, this identifies the drop-off inventory bucket adjusted during equipment type assignment.
• dropSkuQuantityTypeGid: string
  With the DROP_SKU_QUANTITY_GID this indicates the drop-off inventory bucket adjusted during equipment type assignment.
• dryCapacity: dryCapacity
  The maximum interior capacity of the equipment.
• emptyCgHeight: emptyCgHeight
  When empty, indicates the height from top of rail to the center of gravity.
• emptyCgLength: emptyCgLength
  When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.
• emptyCgWidth: emptyCgWidth
  When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.
• equipMaxGrossWt: equipMaxGrossWt
  The maximum allowed gross weight for the equipment.
• equipmentGid: string
  The GID for the actual equipment asset record.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  An equipment group identifies the kind of equipment such as dry vans, flatbed trucks, container cars, hoppers, tankers, box cars, etc.. Equipment groups are primarily used by rate offering applied to the cost of moving goods on a class of equipment defined by the equipment group ID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentInitial: string
  The initial is a mark that is registered with national or international authorities that is associated with a specific owner.
• equipmentInitialNumber: string
  A concatenation of the equipment initial and equipment number.
• equipmentNumber: string
  Number identifying the equipment used.
• equipmentOwnerType: string
  The asset owner of the equipment.
• equipmentType: equipmentType
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentTypeCode: string
  The Equipment Type Code field is used to designate a specific type of equipment and attributes. For information only.
• equipmentTypeGid: string
  An equipment type is a category of equipment. The system uses equipment types when it determines equipment capacity.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• floorHeight: floorHeight
  The actual height of the platform or floor above the ground or the rail.
• freightCgHeight: freightCgHeight
  The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height.
• freightCgLength: freightCgLength
  No description.
• freightCgWidth: freightCgWidth
  No description.
• grossCgHeight: grossCgHeight
  When full, indicates the height from the top of rail to the center of gravity.
• grossCgLength: grossCgLength
  No description.
• grossCgWidth: grossCgWidth
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• intermodalEquipLength: number (int32)
  A specially formatted field that is required by the railroads, representing the length of the equipment. It is in the format FtFtInIn, so 4803 would represent 48 feet, 3 inches.
• isFreight: boolean
  Indicates if the equipment is carrying freight.
• licensePlate: string
  Informational field for identification.
• links: array links
  Read Only: true
• liquidCapacity: liquidCapacity
  The number of gallons the equipment will hold.
• loadConfigVolume: loadConfigVolume
  The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.
• loadingLength: loadingLength
  The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.
• maxAxleWeight: maxAxleWeight
  Maximum allowed axle weight. Applicable only to rail cars.
• mechanicalDesignation: string
  The Mechanical Designation field is an alphabetic code assigned to the physical description of the unit. For information only.
• orEquipmentSeq: number (int32)
  N/A
• pickSkuGid: string
  With PICK_SKU_QUANTITY_TYPE_GID, this identifies the pickup inventory bucket adjusted during equipment type assignment.
• pickSkuQuantityTypeGid: string
  With the PICK_SKU_QUANTITY_GID, this indicates the pickup inventory bucket adjusted during equipment type assignment.
• scaleLocation: string
  Scale location information.
• scaleName: string
  Scale name information.
• scaleTicket: string
  The sequence ID printed on the scale ticket when weight is recorded.
• scaleWeight: scaleWeight
  Weight recorded by scale when the equipment is loaded.
• seals: seals
• sEquipmentGid: string
  The GID for the Equipment associated to a Shipment
• sEquipmentXid: string
  The XID for the equipment associated to a shipment.
• statuses: statuses
• substituteEquipmentGroup: substituteEquipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property substituteEquipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• substituteEquipmentGroupGid: string
  The equipment group substituted by carrier for this equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• tareWeight: tareWeight
  Weight of equipment when empty.
• totalAxleCount: number (int32)
  The total number of axles on the equipment. Applicable only to rail cars.
• truckAAxleWeight: truckAAxleWeight
  Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.
• truckAWeight: truckAWeight
  Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.
• truckBAxleWeight: truckBAxleWeight
  Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.
• truckBWeight: truckBWeight
  Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.
• truckCenterLength: truckCenterLength
  The length between the centers of the two truck/bogie systems. Applicable only to rail cars.
• truckCount: number (int32)
  The total number of trucks/bogies on the equipment. Applicable only to rail cars.
• typeAssignmentCode: string
  The type assignment code (view only) indicates if the equipment is fixed from the order (equipment type was specified on order) or resource capacity, meaning it came from the resource assignment during the build shipment process.
• updateDate: updateDate
  Read Only: true

  update date
• weightQualifier: string
  Indicates what the scale weight and tare weight fields represent: estimate, net or gross weight.

{
    "properties":{
        "sEquipmentGid":{
            "description":"The GID for the Equipment associated to a Shipment",
            "type":"string"
        },
        "sEquipmentXid":{
            "description":"The XID for the equipment associated to a shipment.",
            "type":"string"
        },
        "equipmentInitial":{
            "description":"The initial is a mark that is registered with national or international authorities that is associated with a specific owner.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"Number identifying the equipment used.",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"A concatenation of the equipment initial and equipment number.",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"An equipment type is a category of equipment. The system uses equipment types when it determines equipment capacity.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentType":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentTypes"
                }
            ],
            "readOnly":true
        },
        "equipmentGroupGid":{
            "description":"An equipment group identifies the kind of equipment such as dry vans, flatbed trucks, container cars, hoppers, tankers, box cars, etc.. Equipment groups are primarily used by rate offering applied to the cost of moving goods on a class of equipment defined by the equipment group ID.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "equipmentGid":{
            "description":"The GID for the actual equipment asset record.",
            "type":"string"
        },
        "weightQualifier":{
            "description":"Indicates what the scale weight and tare weight fields represent: estimate, net or gross weight.",
            "type":"string"
        },
        "scaleWeight":{
            "description":"Weight recorded by scale when the equipment is loaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"Weight of equipment when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "scaleLocation":{
            "description":"Scale location information.",
            "type":"string"
        },
        "scaleName":{
            "description":"Scale name information.",
            "type":"string"
        },
        "scaleTicket":{
            "description":"The sequence ID printed on the scale ticket when weight is recorded.",
            "type":"string"
        },
        "intermodalEquipLength":{
            "description":"A specially formatted field that is required by the railroads, representing the length of the equipment. It is in the format FtFtInIn, so 4803 would represent 48 feet, 3 inches.",
            "type":"number",
            "format":"int32"
        },
        "substituteEquipmentGroupGid":{
            "description":"The equipment group substituted by carrier for this equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "substituteEquipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property substituteEquipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "loadConfigVolume":{
            "description":"The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "orEquipmentSeq":{
            "description":"N/A",
            "type":"number",
            "format":"int32"
        },
        "loadingLength":{
            "description":"The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "typeAssignmentCode":{
            "description":"The type assignment code (view only) indicates if the equipment is fixed from the order (equipment type was specified on order) or resource capacity, meaning it came from the resource assignment during the build shipment process. ",
            "type":"string"
        },
        "assignmentCode":{
            "description":"The assignment code (view only) indicates how the equipment was assigned.",
            "type":"string"
        },
        "pickSkuGid":{
            "description":"With PICK_SKU_QUANTITY_TYPE_GID, this identifies the pickup inventory bucket adjusted during equipment type assignment.",
            "type":"string"
        },
        "pickSkuQuantityTypeGid":{
            "description":"With the PICK_SKU_QUANTITY_GID, this indicates the pickup inventory bucket adjusted during equipment type assignment.",
            "type":"string"
        },
        "dropSkuGid":{
            "description":"With the DROP_SKU_QUANTITY_TYPE_GID, this identifies the drop-off inventory bucket adjusted during equipment type assignment.",
            "type":"string"
        },
        "dropSkuQuantityTypeGid":{
            "description":"With the  DROP_SKU_QUANTITY_GID this indicates the drop-off inventory bucket adjusted during equipment type assignment.",
            "type":"string"
        },
        "isFreight":{
            "description":"Indicates if the equipment is carrying freight.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "checkDigit":{
            "description":"The Check Digit field is used to validate that the Equipment Initial/Number field is entered correctly. You can leave this field blank if you do not want to validate Equipment Initial/Number. The ISO 6346 for ocean containers is used to verify the check digit value ",
            "type":"number",
            "format":"int32"
        },
        "licensePlate":{
            "description":"Informational field for identification.",
            "type":"string"
        },
        "equipmentTypeCode":{
            "description":"The Equipment Type Code field is used to designate a specific type of equipment and attributes. For information only.",
            "type":"string"
        },
        "mechanicalDesignation":{
            "description":"The Mechanical Designation field is an alphabetic code assigned to the physical description of the unit. For information only.",
            "type":"string"
        },
        "equipmentOwnerType":{
            "description":"The asset owner of the equipment.",
            "type":"string"
        },
        "equipMaxGrossWt":{
            "description":"The maximum allowed gross weight for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "floorHeight":{
            "description":"The actual height of the platform or floor above the ground or the rail.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgHeight":{
            "description":"When empty, indicates the height from top of rail to the center of gravity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "dryCapacity":{
            "description":"The maximum interior capacity of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "liquidCapacity":{
            "description":"The number of gallons the equipment will hold.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "freightCgHeight":{
            "description":"The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "grossCgHeight":{
            "description":"When full, indicates the height from the top of rail to the center of gravity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "calculatedGrossWt":{
            "description":"The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualLoadLimit":{
            "description":"The maximum permissible weight of the commodity that can be loaded into the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualLength":{
            "description":"The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualWidth":{
            "description":"The inside width of the actual equipment from side walls and linings.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualHeight":{
            "description":"The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgLength":{
            "description":"When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "emptyCgWidth":{
            "description":"When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "freightCgLength":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "freightCgWidth":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "grossCgLength":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "grossCgWidth":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCenterLength":{
            "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckCount":{
            "description":"The total number of trucks/bogies on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "totalAxleCount":{
            "description":"The total number of axles on the equipment. Applicable only to rail cars.",
            "type":"number",
            "format":"int32"
        },
        "maxAxleWeight":{
            "description":"Maximum allowed axle weight. Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckAWeight":{
            "description":"Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckAAxleWeight":{
            "description":"Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckBWeight":{
            "description":"Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "truckBAxleWeight":{
            "description":"Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "axleWeightImbalance":{
            "description":"Denotes the ratio between the calculated axles weights.Applicable only to rail cars.",
            "type":"number",
            "format":"double"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sEquipments.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "attributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sEquipments.attributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sEquipments.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualHeight

The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.

Match All

The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.

Show Source

• object amountType

{
    "description":"The inside height of the actual equipment from the floor to the lowest point of the interior ceiling.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualLength

The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.

Match All

The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.

Show Source

• object amountType

{
    "description":"The inside length of the actual equipment from end to end inside walls, linings, and permanent bulkheads.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualLoadLimit

The maximum permissible weight of the commodity that can be loaded into the equipment.

Match All

The maximum permissible weight of the commodity that can be loaded into the equipment.

Show Source

• object amountType

{
    "description":"The maximum permissible weight of the commodity that can be loaded into the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualWidth

The inside width of the actual equipment from side walls and linings.

Match All

The inside width of the actual equipment from side walls and linings.

Show Source

• object amountType

{
    "description":"The inside width of the actual equipment from side walls and linings.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sEquipments.attributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : calculatedGrossWt

The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight.

Match All

The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight.

Show Source

• object amountType

{
    "description":"The actual sum of the cargo plus the actual tare weight. A calculated version of a scale weight. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : dryCapacity

The maximum interior capacity of the equipment.

Match All

The maximum interior capacity of the equipment.

Show Source

• object amountType

{
    "description":"The maximum interior capacity of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgHeight

When empty, indicates the height from top of rail to the center of gravity.

Match All

When empty, indicates the height from top of rail to the center of gravity.

Show Source

• object amountType

{
    "description":"When empty, indicates the height from top of rail to the center of gravity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgLength

When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.

Match All

When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, the lengthwise position of the center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emptyCgWidth

When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.

Match All

When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.

Show Source

• object amountType

{
    "description":"When empty, the widthwise position of the center of gravity from the equipment bottom leftmost corner.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipMaxGrossWt

The maximum allowed gross weight for the equipment.

Match All

The maximum allowed gross weight for the equipment.

Show Source

• object amountType

{
    "description":"The maximum allowed gross weight for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : equipmentType

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object equipmentTypes

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentTypes"
        }
    ],
    "readOnly":true
}

Nested Schema : floorHeight

The actual height of the platform or floor above the ground or the rail.

Match All

The actual height of the platform or floor above the ground or the rail.

Show Source

• object amountType

{
    "description":"The actual height of the platform or floor above the ground or the rail.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : freightCgHeight

The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height.

Match All

The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height.

Show Source

• object amountType

{
    "description":"The freight center of gravity (view only) shows the calculated center of gravity values for the freight length, width and height. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : freightCgLength

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : freightCgWidth

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : grossCgHeight

When full, indicates the height from the top of rail to the center of gravity.

Match All

When full, indicates the height from the top of rail to the center of gravity.

Show Source

• object amountType

{
    "description":"When full, indicates the height from the top of rail to the center of gravity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : grossCgLength

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : grossCgWidth

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : liquidCapacity

The number of gallons the equipment will hold.

Match All

The number of gallons the equipment will hold.

Show Source

• object amountType

{
    "description":"The number of gallons the equipment will hold.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : loadConfigVolume

The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.

Match All

The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.

Show Source

• object amountType

{
    "description":"The actual volume taken by loading the units. Normally, it is larger than the total volume computed using the unit volume of the unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : loadingLength

The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.

Match All

The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.

Show Source

• object amountType

{
    "description":"The equipment loading length (view only). Created by the system and shows the occupied load length of the equipment. If you have a 48 foot unit and 35 feet is used then the loading length is 35.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : maxAxleWeight

Maximum allowed axle weight. Applicable only to rail cars.

Match All

Maximum allowed axle weight. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Maximum allowed axle weight. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : scaleWeight

Weight recorded by scale when the equipment is loaded.

Match All

Weight recorded by scale when the equipment is loaded.

Show Source

• object amountType

{
    "description":"Weight recorded by scale when the equipment is loaded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sEquipments.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sEquipments.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : substituteEquipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property substituteEquipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property substituteEquipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property substituteEquipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : tareWeight

Weight of equipment when empty.

Match All

Weight of equipment when empty.

Show Source

• object amountType

{
    "description":"Weight of equipment when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckAAxleWeight

Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.

Match All

Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Calculated axle weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckAWeight

Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.

Match All

Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Calculated weight on the truck/bogie A. A represents the bogie nearest to the origin of the equipment group.Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckBAxleWeight

Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.

Match All

Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Calculated axle weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckBWeight

Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.

Match All

Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"Calculated weight on the truck/bogie B. B represents the bogie at the end of the equipment group.Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : truckCenterLength

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Match All

The length between the centers of the two truck/bogie systems. Applicable only to rail cars.

Show Source

• object amountType

{
    "description":"The length between the centers of the two truck/bogie systems. Applicable only to rail cars.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object sEquipments.attributes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sEquipments.attributes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sEquipments.attributes

Type: object

Show Source

• domainName: string
  No description.
• equipmentAttributeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• equipmentAttributeValue: string
  Value associated with this S_EQUIPMENT for the given Equipment Attribute Qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentAttributeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "equipmentAttributeValue":{
            "description":"Value associated with this S_EQUIPMENT for the given Equipment Attribute Qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object sEquipments.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sEquipments.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sEquipments.seals

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• sealNumber: string
  The identification of the seal.
• sealSequence: number (int32)
  Refers to the compartment being sealed.

{
    "properties":{
        "sealSequence":{
            "description":"Refers to the compartment being sealed.",
            "type":"number",
            "format":"int32"
        },
        "sealNumber":{
            "description":"The identification of the seal.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object sEquipments.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sEquipments.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sEquipments.statuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  No description.
• statusValueGid: string
  No description.

{
    "properties":{
        "statusTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.costs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code GID associated with the shipment cost.
• accessorialCostGid: string
  The accessorial cost GID associated with the shipment cost.
• adjustmentReasonGid: string
  The reason why this cost was added.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency2: attributeCurrency2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency3: attributeCurrency3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• billableIndicatorGid: string
  Indicates the billable status of this shipment cost (sell shipment only).
• cost: cost
  The cost as it relegates to the cost type for the shipment.
• costCategoryGid: string
  Read Only: true

  The Cost Category Identifier associated with the Shipment Cost
• costIdentifier: string
  It will be used to identify or describe a cost.
• costType: string
  C, A, B
• details: details
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  The date to be used for any currency conversions; if null, the latest conversion is used.
• exchangeRateGid: string
  The set of exchange rates to use for currency conversions; if null, the default set is used.
• generalLedgerGid: string
  The GL code for the shipment cost record.
• isCostFixed: boolean
  Indicates shipment cost is a fixed cost.
• isWeighted: boolean
  Read Only: true

  Whether or not the cost affects the total weighted cost of the shipment only.
• links: array links
  Read Only: true
• paymentMethodCodeGid: string
  The payment method code for the shipment cost.
• processAsFlowThru: boolean
  The override for a record to be copied to the sell side during rating.
• rateGeoCostGroupGid: string
  The rate detail cost group GID associated with the shipment cost.
• rateGeoCostSeq: number (int64)
  The rate detail cost sequence identifier associated with the shipment cost.
• refs: refs
• remarks: remarks
• shipmentCostSeqno: number (int64)
  A system-generated unique sequence number to define the shipment costs. This attribute is marked as Create-Only.
• specialServiceGid: string
  The special service GID associated with the shipment cost.
• sShipUnitGid: string
  Points to the ship unit (if any) associated with this shipment cost, as a package.
• sShipUnitLineNo: number (int64)
  Points to the ship unit line (if any) associated with this shipment cost, as a package.
• trackingNumber: string
  Denotes the tracking number associated with a specific charge/cost.

{
    "properties":{
        "shipmentCostSeqno":{
            "description":"A system-generated unique sequence number to define the shipment costs. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int64"
        },
        "costType":{
            "description":"C, A, B",
            "type":"string"
        },
        "cost":{
            "description":"The cost as it relegates to the cost type for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"The accessorial code GID associated with the shipment cost.",
            "type":"string"
        },
        "accessorialCostGid":{
            "description":"The accessorial cost GID associated with the shipment cost.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"Indicates the billable status of this shipment cost (sell shipment only).",
            "type":"string"
        },
        "rateGeoCostGroupGid":{
            "description":"The rate detail cost group GID associated with the shipment cost.",
            "type":"string"
        },
        "rateGeoCostSeq":{
            "description":"The rate detail cost sequence identifier associated with the shipment cost.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service GID associated with the shipment cost.",
            "type":"string"
        },
        "isCostFixed":{
            "description":"Indicates shipment cost is a fixed cost.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"The override for a record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why this cost was added.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"The GL code for the shipment cost record.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method code for the shipment cost.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"The date to be used for any currency conversions; if null, the latest conversion is used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"The set of exchange rates to use for currency conversions; if null, the default set is used.",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"Points to the ship unit (if any) associated with this shipment cost, as a package.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"Points to the ship unit line (if any) associated with this shipment cost, as a package.",
            "type":"number",
            "format":"int64"
        },
        "isWeighted":{
            "description":"Whether or not the cost affects the total weighted cost of the shipment only.",
            "type":"boolean",
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costCategoryGid":{
            "description":"The Cost Category Identifier associated with the Shipment Cost",
            "type":"string",
            "readOnly":true
        },
        "trackingNumber":{
            "description":"Denotes the tracking number associated with a specific charge/cost.",
            "type":"string"
        },
        "costIdentifier":{
            "description":"It will be used to identify or describe a cost.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150) ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.costs.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.costs.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.costs.refs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

The cost as it relegates to the cost type for the shipment.

Match All

The cost as it relegates to the cost type for the shipment.

Show Source

• object currencyType

{
    "description":"The cost as it relegates to the cost type for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.costs.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

The date to be used for any currency conversions; if null, the latest conversion is used.

Match All

The date to be used for any currency conversions; if null, the latest conversion is used.

Show Source

• object dateType

{
    "description":"The date to be used for any currency conversions; if null, the latest conversion is used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : refs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.costs.refs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.costs.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.costs.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• detail: string
  The textual description of the cost detail as calculated and applied by the rating engine.
• detailSeqno: number (int64)
  A one-up number to make the cost detail record unique.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "detailSeqno":{
            "description":"A one-up number to make the cost detail record unique.",
            "type":"number",
            "format":"int64"
        },
        "detail":{
            "description":"The textual description of the cost detail as calculated and applied by the rating engine.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.costs.refs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• costReferenceGid: string
  The cost reference GID.
• domainName: string
  Database domain where this data is stored.
• isDropoff: boolean
  True or false value to specify if the cost is a dropoff cost.
• isPickup: boolean
  True or false value to specify if the cost is a pickup cost.
• links: array links
  Read Only: true
• seqno: number (int64)
  A system-generated unique sequence number.
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentCostQualGid: string
  A GID for the various cost qualifiers like: item, order base, order release, order release line, etc.
• shipmentGid: string
  The shipment GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "seqno":{
            "description":"A system-generated unique sequence number.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"The shipment GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "costReferenceGid":{
            "description":"The cost reference GID.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"A GID for the various cost qualifiers like: item, order base, order release, order release line, etc.",
            "type":"string"
        },
        "isPickup":{
            "description":"True or false value to specify if the cost is a pickup cost.",
            "type":"boolean"
        },
        "isDropoff":{
            "description":"True or false value to specify if the cost is a dropoff cost.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.costs.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, or remark type.
• remarkSequence: number (int64)
  The one-up number to make this remark unique.
• remarkText: string
  The remark text.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make this remark unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object sellShipments.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sellShipments.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.informationalCosts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• cost: cost
  The cost amount.
• detail: string
  Generated text that details the calculation of the cost.
• details: details
• domainName: string
  Database domain where this data is stored.
• infCostType: string
  Type of informational cost. O = Original, D = Display
• links: array links
  Read Only: true
• remarks: remarks
• shipmentInfCostQualGid: string
  The shipment informational cost qualifier GID for this cost.
• shipmentInfCostSeqno: number (int64)
  The shipment informational cost sequence number.

{
    "properties":{
        "shipmentInfCostSeqno":{
            "description":"The shipment informational cost sequence number.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"The cost amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "detail":{
            "description":"Generated text that details the calculation of the cost.",
            "type":"string"
        },
        "infCostType":{
            "description":"Type of informational cost.  O = Original, D = Display",
            "type":"string"
        },
        "shipmentInfCostQualGid":{
            "description":"The shipment informational cost qualifier GID for this cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.informationalCosts.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.informationalCosts.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

The cost amount.

Match All

The cost amount.

Show Source

• object currencyType

{
    "description":"The cost amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.informationalCosts.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.informationalCosts.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.informationalCosts.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.
• accessorialCostGid: string
  The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.
• adjustmentReasonGid: string
  An adjustment reason code GID that categorizes the cost element as an adjustment and the type.
• cost: cost
  The cost value. Examples are base and accessorial.
• costType: string
  The cost type for this shipment cost record.
• detailSeqno: number (int64)
  The detail sequence number (key).
• domainName: string
  Database domain where this data is stored.
• generalLedgerGid: string
  The general ledger GID associated with the cost element and sent to financial systems.
• isCostFixed: boolean
  A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.
• links: array links
  Read Only: true
• processAsFlowThru: boolean
  A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.
• rateGeoCostGroupGid: string
  The rate detail cost group identifier that was used in calculating this cost value.
• rateGeoCostSeq: number (int64)
  The rate detail cost sequence that was used in calculating this cost value.
• specialServiceGid: string
  The special service identifier associated to the cost record if it was calculated from a special service.

{
    "properties":{
        "detailSeqno":{
            "description":"The detail sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "costType":{
            "description":"The cost type for this shipment cost record.",
            "type":"string"
        },
        "cost":{
            "description":"The cost value. Examples are base and accessorial.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "accessorialCostGid":{
            "description":"The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "rateGeoCostGroupGid":{
            "description":"The rate detail cost group identifier that was used in calculating this cost value.",
            "type":"string"
        },
        "rateGeoCostSeq":{
            "description":"The rate detail cost sequence that was used in calculating this cost value.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service identifier associated to the cost record if it was calculated from a special service.",
            "type":"string"
        },
        "isCostFixed":{
            "description":"A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"An adjustment reason code GID  that categorizes the cost element as an adjustment and the type.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"The general ledger GID associated with the cost element and sent to financial systems.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

The cost value. Examples are base and accessorial.

Match All

The cost value. Examples are base and accessorial.

Show Source

• object currencyType

{
    "description":"The cost value. Examples are base and accessorial.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.informationalCosts.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSeq: number (int64)
  The remark sequence number (key).
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSeq":{
            "description":"The remark sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The communication ,method for the involved party listed on the shipment.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The involved party contact for the qualifier listed on the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The involved party qualifier identifier.
• links: array links
  Read Only: true
• overrideAddresses: overrideAddresses
• overrideCity: string
  The location city that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.
• overrideCountryCode3Gid: string
  The location country code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
• overrideLocationName: string
  The location name that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.
• overridePostalCode: string
  The location postal code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
• overrideProvince: string
  The location providence that is to be used for this involved party on a shipment in place of (overridden) the one on the location table
• overrideProvinceCode: string
  The location providence code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The involved party qualifier identifier.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The involved party contact for the qualifier listed on the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication ,method for the involved party listed on the shipment.",
            "type":"string"
        },
        "overrideLocationName":{
            "description":"The location name that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideCity":{
            "description":"The location city that is to be used for this involved party on a shipment in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideProvince":{
            "description":"The location providence  that is to be used for this involved party on a shipment in place of (overridden) the one on the location table",
            "type":"string"
        },
        "overrideProvinceCode":{
            "description":"The location providence code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table",
            "type":"string"
        },
        "overrideCountryCode3Gid":{
            "description":"The location country code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table",
            "type":"string"
        },
        "overridePostalCode":{
            "description":"The location postal code that is to be used for this involved party on a shipment in place of (overridden) the one on the location table",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "overrideAddresses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.involvedParties.overrideAddresses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : overrideAddresses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.involvedParties.overrideAddresses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.involvedParties.overrideAddresses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• lineSequence: number (int64)
  The line sequence (key) for the involved party on the shipment.
• links: array links
  Read Only: true
• overrideAddressLine: string
  The address line that is to be used for this involved party on a shipment in place (Overridden) of the one on the contact table for the involved party.

{
    "properties":{
        "lineSequence":{
            "description":"The line sequence (key) for the involved party on the shipment.",
            "type":"number",
            "format":"int64"
        },
        "overrideAddressLine":{
            "description":"The address line that is to be used for this involved party on a shipment in place (Overridden) of the one on the contact table for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.orderReleases"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• description: string
  The description of the equipment reference unit values.
• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The equipment reference units GID.
• isFixedNumReferenceUnits: boolean
  A Y/N indicator to specify that these calculated fields should remain permanent after a shipment modification.
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of reference units used.
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  The order release GID on the shipment for the equipment reference units used.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "orderReleaseGid":{
            "description":"The order release GID on the shipment for the equipment reference units used. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "numReferenceUnits":{
            "description":"The number of reference units used.",
            "type":"number",
            "format":"double"
        },
        "isFixedNumReferenceUnits":{
            "description":"A Y/N indicator to specify that these calculated fields should remain permanent after a shipment modification.",
            "type":"boolean"
        },
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference units GID.",
            "type":"string"
        },
        "description":{
            "description":"The description of the equipment reference unit values.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentRefnumQualGid: string
  The reference qualifier GID defining the reference code.
• shipmentRefnumValue: string
  The value associated to the reference code.

{
    "properties":{
        "shipmentRefnumQualGid":{
            "description":"The reference qualifier GID defining the reference  code.",
            "type":"string"
        },
        "shipmentRefnumValue":{
            "description":"The value associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
• remarkSequence: number (int64)
  The remark sequence (key) associated with the shipment remarks.
• remarkText: string
  A user-entered remark on the shipment.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence (key) associated with the shipment remarks.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.",
            "type":"string"
        },
        "remarkText":{
            "description":"A user-entered remark on the shipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.reqdocs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• docs: docs
• documentDefGid: string
  The required document type for the shipment.
• domainName: string
  Database domain where this data is stored.
• instructions: string
  The instruction associated with handling of the document.
• links: array links
  Read Only: true
• numRevisions: number (int32)
  The number of document revisions generated.
• reviewers: reviewers
• reviewStatus: string
  The status of the review of the document.
• statuses: statuses
• subscribers: subscribers
• texts: texts

{
    "properties":{
        "documentDefGid":{
            "description":"The required document type for the shipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numRevisions":{
            "description":"The number of document revisions generated.",
            "type":"number",
            "format":"int32"
        },
        "reviewStatus":{
            "description":"The status of the review of the document.",
            "type":"string"
        },
        "instructions":{
            "description":"The instruction associated with handling of the document.",
            "type":"string"
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.reqdocs.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "reviewers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.reqdocs.reviewers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "subscribers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.reqdocs.subscribers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.reqdocs.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "docs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.reqdocs.docs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : docs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.reqdocs.docs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : reviewers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.reqdocs.reviewers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.reqdocs.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : subscribers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.reqdocs.subscribers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.reqdocs.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.reqdocs.docs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• annotations: string
  The document revision annotations.
• document: document
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• documentCmsName: string
  The document name used to identify a set of revisions (versions) for a CMS.
• documentGid: string
  The document GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• documentRevision: number (int32)
  The document revision count.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• review: string
  The document review state.
• reviews: reviews

{
    "properties":{
        "documentGid":{
            "description":"The document GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "document":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "documentRevision":{
            "description":"The document revision count.",
            "type":"number",
            "format":"int32"
        },
        "review":{
            "description":"The document review state.",
            "type":"string"
        },
        "annotations":{
            "description":"The document revision annotations.",
            "type":"string"
        },
        "documentCmsName":{
            "description":"The document name used to identify a set of revisions (versions) for a CMS.",
            "type":"string"
        },
        "reviews":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.reqdocs.docs.reviews"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : document

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property documentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : reviews

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.reqdocs.docs.reviews"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.reqdocs.docs.reviews"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comments: string
  Comments added by the reviewer.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The reviewer GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• state: string
  The review state.

{
    "properties":{
        "contactGid":{
            "description":"The reviewer GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "state":{
            "description":"The review state.",
            "type":"string"
        },
        "comments":{
            "description":"Comments added by the reviewer.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.reqdocs.reviewers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• asInvolvedPartyQualGid: string
  The involved party qualifier for reviewer, if it is acting as a party on the shipment.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The reviewer.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The reviewer. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"The involved party qualifier for reviewer, if it is acting as a party on the shipment.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object sellShipments.reqdocs.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.reqdocs.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sellShipments.reqdocs.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type.
• statusValueGid: string
  The status value.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.reqdocs.subscribers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• asInvolvedPartyQualGid: string
  The involved party qualifier for subscriber, if it is acting as a party on the shipment.
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The subscriber GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "contactGid":{
            "description":"The subscriber GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "asInvolvedPartyQualGid":{
            "description":"The involved party qualifier for subscriber, if it is acting as a party on the shipment.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.reqdocs.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• sShipUnitGid: string
  If the text is associated with a ship unit or ship unit line, this holds the ship unit ID.
• sShipUnitLineNo: number (int64)
  If the text is associated with a ship unit line, this holds the ship unit line number.
• textTemplateGid: string
  The text template ID.

{
    "properties":{
        "textTemplateGid":{
            "description":"The text template ID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"If the text is associated with a ship unit or ship unit line, this holds the ship unit ID.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"If the text is associated with a ship unit line, this holds the ship unit line number.",
            "type":"number",
            "format":"int64"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.sEquipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• capacityUsageGid: string
  The capacity usage GID that was used for the shipment.
• domainName: string
  Database domain where this data is stored.
• dropoffStopNum: number (int32)
  The stop number where the equipment is dropped off. It is null if not dropped off in this shipment.
• links: array links
  Read Only: true
• pickupStopNum: number (int32)
  The stop number where the equipment is picked up. It is null if not picked up in this shipment.
• sEquipment: sEquipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sEquipmentGid: string
  The GID for the equipment associated with the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sEquipmentIndex: number (int32)
  The standing order of the equipment on the shipment.

{
    "properties":{
        "sEquipmentGid":{
            "description":"The GID for the equipment associated with the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sEquipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sEquipments"
                }
            ],
            "readOnly":true
        },
        "capacityUsageGid":{
            "description":"The capacity usage GID that was used for the shipment.",
            "type":"string"
        },
        "pickupStopNum":{
            "description":"The stop number where the equipment is picked up.  It is null if not picked up in this shipment.",
            "type":"number",
            "format":"int32"
        },
        "dropoffStopNum":{
            "description":"The stop number where the equipment is dropped off. It is null if not dropped off in this shipment.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sEquipmentIndex":{
            "description":"The standing order of the equipment on the shipment.",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sEquipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object sEquipments

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sEquipments"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• actualDistance: actualDistance
  The actual distance of the special service.
• actualDuration: actualDuration
  The actual duration of the special service.
• actualItemPackageCount: number (int64)
  The actual package count applicable to this special service.
• actualOccurTime: actualOccurTime
  The actual date and time special service occurred.
• actualShipUnitCount: number (int64)
  The actual ship unit count applicable to this special service.
• actualVolume: actualVolume
  The actual volume of the goods applicable to this special service.
• actualWeight: actualWeight
  The actual weight of the goods applicable to this special service.
• adjustmentReasonGid: string
  The reason why charge was added.
• billableIndicatorGid: string
  indicates the billable status of this special service; if values, overrides the billable status on the special service itself.
• completionState: string
  Indicates completion state of this special service.
• domainName: string
  Database domain where this data is stored.
• isPlannedDurationFixed: boolean
  If Y, prevents the system from overwriting the planned duration for the special service.
• isSystemGenerated: boolean
  Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.
• links: array links
  Read Only: true
• payableIndicatorGid: string
  Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.
• plannedDuration: plannedDuration
  The planned duration of the special service.
• processAsFlowThru: boolean
  The override for record to be copied to the sell side during rating.
• refs: refs
• remarks: remarks
• shipmentSpecialServiceSeq: number (int64)
  The sequence to keep shipment special services unique.
• specialServiceGid: string
  The special service associated with the remark.
• stopNum: number (int32)
  If the special service is for a particular stop, this indicates the stop number.

{
    "properties":{
        "shipmentSpecialServiceSeq":{
            "description":"The sequence to keep shipment special services unique.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service associated with the remark.",
            "type":"string"
        },
        "stopNum":{
            "description":"If the special service is for a particular stop, this indicates the stop number.",
            "type":"number",
            "format":"int32"
        },
        "processAsFlowThru":{
            "description":"The override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why charge was added.",
            "type":"string"
        },
        "completionState":{
            "description":"Indicates completion state of this special service.",
            "type":"string"
        },
        "payableIndicatorGid":{
            "description":"Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"indicates the billable status of this special service; if values, overrides the billable status on the special service itself.",
            "type":"string"
        },
        "actualOccurTime":{
            "description":"The actual date and time special service occurred.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDuration":{
            "description":"The planned duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPlannedDurationFixed":{
            "description":"If Y, prevents the system from overwriting the planned duration for the special service.",
            "type":"boolean"
        },
        "actualDuration":{
            "description":"The actual duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualDistance":{
            "description":"The actual distance of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualWeight":{
            "description":"The actual weight of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualVolume":{
            "description":"The actual volume of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualShipUnitCount":{
            "description":"The actual ship unit count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "actualItemPackageCount":{
            "description":"The actual package count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "isSystemGenerated":{
            "description":"Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.specialServices.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.specialServices.refs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualDistance

The actual distance of the special service.

Match All

The actual distance of the special service.

Show Source

• object amountType

{
    "description":"The actual distance of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualDuration

The actual duration of the special service.

Match All

The actual duration of the special service.

Show Source

• object amountType

{
    "description":"The actual duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualOccurTime

The actual date and time special service occurred.

Match All

The actual date and time special service occurred.

Show Source

• object dateTimeType

{
    "description":"The actual date and time special service occurred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : actualVolume

The actual volume of the goods applicable to this special service.

Match All

The actual volume of the goods applicable to this special service.

Show Source

• object amountType

{
    "description":"The actual volume of the goods applicable to this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualWeight

The actual weight of the goods applicable to this special service.

Match All

The actual weight of the goods applicable to this special service.

Show Source

• object amountType

{
    "description":"The actual weight of the goods applicable to this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : plannedDuration

The planned duration of the special service.

Match All

The planned duration of the special service.

Show Source

• object amountType

{
    "description":"The planned duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.specialServices.refs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.specialServices.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.specialServices.refs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• costReferenceGid: string
  The cost reference GID for the shipment special service.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentCostQualGid: string
  The shipment cost qualifier associated to the cost reference.

{
    "properties":{
        "costReferenceGid":{
            "description":"The cost reference GID for the shipment special service.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The shipment cost qualifier associated to the cost reference.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.specialServices.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, or type.
• remarkSequence: number (int64)
  The one-up number to make the remark unique.
• remarkText: string
  The remark text itself.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text itself.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type GID for the status value on the shipment.
• statusValueGid: string
  The status value for the shipment status.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type GID for the status value on the shipment.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the shipment status.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialTime: accessorialTime
  The sum of the fixed accessorial time for a particular stop.
• activityTime: activityTime
  The time spent at the stop for pickup or delivery.
• actualArrival: actualArrival
  A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
• actualDeparture: actualDeparture
  The actual departure date and time at the stop.
• appointmentDelivery: appointmentDelivery
  A Y/N indicator defining if the stop requires a delivery appointment.
• appointmentDuration: appointmentDuration
  The total appointment duration at the stop.
• appointmentPickup: appointmentPickup
  A Y/N indicator defining if the stop requires a pickup appointment.
• appointmentWindowEnd: appointmentWindowEnd
  The appointment window end.
• appointmentWindowStart: appointmentWindowStart
  The appointment window start.
• arbitraryType: string
  SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• debriefs: debriefs
• details: details
• distanceType: string
  Read Only: true

  L - Loaded, B- Bobtail, D - Deadhead
• distFromPrevStop: distFromPrevStop
  The distance from the last stop.
• domainName: string
  Database domain where this data is stored.
• driverNonPayable: boolean
  Allows the user to specify that stop is payable or not.
• driveTime: driveTime
  The drive time to the stop from the last stop.
• estimatedArrival: estimatedArrival
  The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.
• estimatedDeparture: estimatedDeparture
  The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.
• externalVoyageCode: string
  Specifies the number of the voyage as assigned by the carrier that transports the shipments from this stop.
• extSeqNo: number (int32)
  The external sequence number for the stop.
• flightInstanceId: number (int64)
  Read Only: true

  The flight instance GID.
• fwdLengthOog: fwdLengthOog
  Read Only: true

  The forward length-wise out of gauge.
• involvedParties: involvedParties
• isDepot: boolean
  A Y/N indicator used to define if the stop is a depot. This attribute is marked as Create-Only.
• isFixedArrival: boolean
  A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.
• isFixedDeparture: boolean
  A Y/N indicator defining the departure time as fixed and will not be changed on subsequent modification.
• isFixedDistance: boolean
  When set to Y, indicates the existence of a user-entered value for the distance from previous stop field.
• isMotherVessel: boolean
  Designates a leg as mother vessel to automatically populated header.
• isPermanent: boolean
  A Y/N indicator defining the stop as permanent and will not be changed on subsequent modifications.
• leftWidthOog: leftWidthOog
  Read Only: true

  The left width-wise out of gauge.
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  The location GID for the shipment stop.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• locationOverrideGid: string
  The location GID defining the location to be used to override the actual location on the stop record.
• locationRoleGid: string
  The location role GID for the shipment stop (such as port, cross dock, etc.).
• nfrStopType: string
  Defines how or process that NFR stop got added
• parentLocation: parentLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentLocationGid: string
  If an operational location, such as terminal at a port, is chosen for this stop, the location GID will be copied to this field and the location GID field will contain the operational location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• plannedArrival: plannedArrival
  The planned date and time of arrival at the stop.
• plannedDeparture: plannedDeparture
  The planned departure date and time at the stop.
• predictedArrival: predictedArrival
  Read Only: true

  Denotes the predicted arrival time at the stop.
• predictedArrivalHigh: predictedArrivalHigh
  Denotes the predicted arrival time high value at the stop.
• predictedArrivalLow: predictedArrivalLow
  Denotes the predicted arrival time low value at the stop.
• rateDistanceGid: string
  The rate distance to be used when finding distance from this stop to next stop. This is done mainly for arbitrary case.
• rateServiceGid: string
  The rate service GID set if the stop times were calculated using the rate service engine.
• rearLengthOog: rearLengthOog
  Read Only: true

  The rear length-wise out of gauge.
• refnums: refnums
• remarks: remarks
• repetitionSchedStopNumber: number (int32)
  Read Only: true

  The repetition schedule stop GID if the stop times were calculated from a repetition schedule.
• repetitionScheduleGid: string
  Read Only: true

  The repetition schedule GID if the stop times were calculated from a repetition schedule.
• restTime: restTime
  The time the truck or the transportation mode should take for rest at the stop.
• rightWidthOog: rightWidthOog
  Read Only: true

  The right width-wise out of gauge.
• routeCodeGid: string
  The route code to be used when finding distance from this stop to next stop This is done mainly for handling arbitrary case.
• runningHeight: runningHeight
  Read Only: true

  The running total height from current stop to next stop.
• runningLength: runningLength
  Read Only: true

  The running total length from current stop to next stop.
• runningWeight: runningWeight
  Read Only: true

  The running total weight from current stop to next stop.
• runningWidth: runningWidth
  Read Only: true

  The running total width from current stop to next stop.
• rushHourTime: rushHourTime
  The amount of time that the drive time defined on the stop in inside the rush hour window.
• slackVariance: number (double)
  Read Only: true

  The slack variance.
• stopNum: number (int32)
  The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop. This attribute is marked as Create-Only.
• stopRequirementType: string
  Used only for trips.
• stopType: string
  Define the type of this stop.
• voyage: voyage
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voyageGid: string
  Read Only: true

  The voyage GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• waitTime: waitTime
  The time the truck or the transportation mode has to wait at the stop.

{
    "properties":{
        "stopNum":{
            "description":"The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"The location GID for the shipment stop. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "locationRoleGid":{
            "description":"The location role GID for the shipment stop (such as port, cross dock, etc.).",
            "type":"string"
        },
        "plannedArrival":{
            "description":"The planned date and time of arrival at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedArrival":{
            "description":"The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isFixedArrival":{
            "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
            "type":"boolean"
        },
        "actualArrival":{
            "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDeparture":{
            "description":"The planned departure date and time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedDeparture":{
            "description":"The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isFixedDeparture":{
            "description":"A Y/N indicator defining the departure time as fixed and will not be changed on subsequent modification.",
            "type":"boolean"
        },
        "actualDeparture":{
            "description":"The actual departure date and time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "waitTime":{
            "description":"The time the truck or the transportation mode has to wait at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "restTime":{
            "description":"The time the truck or the transportation mode should take for rest at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "driveTime":{
            "description":"The drive time to the stop from the last stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "distFromPrevStop":{
            "description":"The distance from the last stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "activityTime":{
            "description":"The time spent at the stop for pickup or delivery.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"A Y/N indicator defining the stop as permanent and will not be changed on subsequent modifications.",
            "type":"boolean"
        },
        "isDepot":{
            "description":"A Y/N indicator used to define if the stop is a depot. This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "appointmentPickup":{
            "description":"A Y/N indicator defining if the stop requires a pickup appointment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentDelivery":{
            "description":"A Y/N indicator defining if the stop requires a delivery appointment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "accessorialTime":{
            "description":"The sum of the fixed accessorial time for a particular stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "parentLocationGid":{
            "description":"If an operational location, such as terminal at a port, is chosen for this stop, the location GID will be copied to this field and the location GID field will contain the operational location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "locationOverrideGid":{
            "description":"The location GID defining the location to be used to override the actual location on the stop record.",
            "type":"string"
        },
        "stopRequirementType":{
            "description":"Used only for trips.",
            "type":"string"
        },
        "rateServiceGid":{
            "description":"The rate service GID set if the stop times were calculated using the rate service engine.",
            "type":"string"
        },
        "arbitraryType":{
            "description":"SOURCE or DEST to indicate the type of arbitrary. If null, this stop is not an arbitrary.",
            "type":"string"
        },
        "isFixedDistance":{
            "description":"When set to Y, indicates the existence of a user-entered value for the distance from previous stop field.",
            "type":"boolean"
        },
        "extSeqNo":{
            "description":"The external sequence number for the stop.",
            "type":"number",
            "format":"int32"
        },
        "rushHourTime":{
            "description":"The amount of time that the drive time defined on the stop in inside the rush hour window.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "voyageGid":{
            "description":"The voyage GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "voyage":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/voyages"
                }
            ],
            "readOnly":true
        },
        "isMotherVessel":{
            "description":"Designates a leg as mother vessel to automatically populated header.",
            "type":"boolean"
        },
        "flightInstanceId":{
            "description":"The flight instance GID.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "repetitionScheduleGid":{
            "description":"The repetition schedule GID if the stop times were calculated from a repetition schedule.",
            "type":"string",
            "readOnly":true
        },
        "stopType":{
            "description":"Define the type of this stop.",
            "type":"string"
        },
        "slackVariance":{
            "description":"The slack variance.",
            "type":"number",
            "format":"double",
            "readOnly":true
        },
        "driverNonPayable":{
            "description":"Allows the user to specify that stop is payable or not.",
            "type":"boolean"
        },
        "repetitionSchedStopNumber":{
            "description":"The repetition schedule stop GID if the stop times were calculated from a repetition schedule.",
            "type":"number",
            "format":"int32",
            "readOnly":true
        },
        "distanceType":{
            "description":"L - Loaded, B- Bobtail, D - Deadhead",
            "type":"string",
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentWindowStart":{
            "description":"The appointment window start.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "appointmentWindowEnd":{
            "description":"The appointment window end.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "rateDistanceGid":{
            "description":"The rate distance to be used when finding distance from this stop to next stop. This is done mainly for arbitrary case. ",
            "type":"string"
        },
        "routeCodeGid":{
            "description":"The route code to be used when finding distance from this stop to next stop This is done mainly for handling arbitrary case. ",
            "type":"string"
        },
        "runningWeight":{
            "description":"The running total weight from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningLength":{
            "description":"The running total length from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningWidth":{
            "description":"The running total width from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "runningHeight":{
            "description":"The running total height from current stop to next stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "leftWidthOog":{
            "description":"The left width-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "rightWidthOog":{
            "description":"The right width-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "fwdLengthOog":{
            "description":"The forward length-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "rearLengthOog":{
            "description":"The rear length-wise out of gauge.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ],
            "readOnly":true
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "predictedArrival":{
            "description":"Denotes the predicted arrival time at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ],
            "readOnly":true
        },
        "predictedArrivalLow":{
            "description":"Denotes the predicted arrival time low value at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "predictedArrivalHigh":{
            "description":"Denotes the predicted arrival time high value at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "externalVoyageCode":{
            "description":"Specifies the number of the voyage as assigned by the carrier that transports the shipments from this stop.",
            "type":"string"
        },
        "appointmentDuration":{
            "description":"The total appointment duration at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "nfrStopType":{
            "description":"Defines how or process that NFR stop got added",
            "type":"string"
        },
        "debriefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.debriefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorialTime

The sum of the fixed accessorial time for a particular stop.

Match All

The sum of the fixed accessorial time for a particular stop.

Show Source

• object amountType

{
    "description":"The sum of the fixed accessorial time for a particular stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : activityTime

The time spent at the stop for pickup or delivery.

Match All

The time spent at the stop for pickup or delivery.

Show Source

• object amountType

{
    "description":"The time spent at the stop for pickup or delivery.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualArrival

A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.

Match All

A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.

Show Source

• object dateTimeType

{
    "description":"A Y/N indicator defining the arrival time as fixed and will not be changed on subsequent modification.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : actualDeparture

The actual departure date and time at the stop.

Match All

The actual departure date and time at the stop.

Show Source

• object dateTimeType

{
    "description":"The actual departure date and time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentDelivery

A Y/N indicator defining if the stop requires a delivery appointment.

Match All

A Y/N indicator defining if the stop requires a delivery appointment.

Show Source

• object dateTimeType

{
    "description":"A Y/N indicator defining if the stop requires a delivery appointment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentDuration

The total appointment duration at the stop.

Match All

The total appointment duration at the stop.

Show Source

• object amountType

{
    "description":"The total appointment duration at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : appointmentPickup

A Y/N indicator defining if the stop requires a pickup appointment.

Match All

A Y/N indicator defining if the stop requires a pickup appointment.

Show Source

• object dateTimeType

{
    "description":"A Y/N indicator defining if the stop requires a pickup appointment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentWindowEnd

The appointment window end.

Match All

The appointment window end.

Show Source

• object dateTimeType

{
    "description":"The appointment window end.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : appointmentWindowStart

The appointment window start.

Match All

The appointment window start.

Show Source

• object dateTimeType

{
    "description":"The appointment window start.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : debriefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.debriefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : distFromPrevStop

The distance from the last stop.

Match All

The distance from the last stop.

Show Source

• object amountType

{
    "description":"The distance from the last stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : driveTime

The drive time to the stop from the last stop.

Match All

The drive time to the stop from the last stop.

Show Source

• object amountType

{
    "description":"The drive time to the stop from the last stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : estimatedArrival

The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.

Match All

The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.

Show Source

• object dateTimeType

{
    "description":"The estimated time of arrival at the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to delivery. It represents to the best of our knowledge, when we expect the shipment to arrive.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : estimatedDeparture

The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.

Match All

The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.

Show Source

• object dateTimeType

{
    "description":"The estimated time of departure for the stop. It represents the up to the minute ETA that takes into account ETA updates. This date is editable by the carrier or load planner and should incorporate any known delays to departure. It represents to the best of our knowledge, when we expect the shipment to depart from the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : fwdLengthOog

Read Only: true

The forward length-wise out of gauge.

Match All

The forward length-wise out of gauge.

Show Source

• object amountType

{
    "description":"The forward length-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : leftWidthOog

Read Only: true

The left width-wise out of gauge.

Match All

The left width-wise out of gauge.

Show Source

• object amountType

{
    "description":"The left width-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : parentLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : plannedArrival

The planned date and time of arrival at the stop.

Match All

The planned date and time of arrival at the stop.

Show Source

• object dateTimeType

{
    "description":"The planned date and time of arrival at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : plannedDeparture

The planned departure date and time at the stop.

Match All

The planned departure date and time at the stop.

Show Source

• object dateTimeType

{
    "description":"The planned departure date and time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : predictedArrival

Read Only: true

Denotes the predicted arrival time at the stop.

Match All

Denotes the predicted arrival time at the stop.

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ],
    "readOnly":true
}

Nested Schema : predictedArrivalHigh

Denotes the predicted arrival time high value at the stop.

Match All

Denotes the predicted arrival time high value at the stop.

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time high value at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : predictedArrivalLow

Denotes the predicted arrival time low value at the stop.

Match All

Denotes the predicted arrival time low value at the stop.

Show Source

• object dateTimeType

{
    "description":"Denotes the predicted arrival time low value at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : rearLengthOog

Read Only: true

The rear length-wise out of gauge.

Match All

The rear length-wise out of gauge.

Show Source

• object amountType

{
    "description":"The rear length-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : restTime

The time the truck or the transportation mode should take for rest at the stop.

Match All

The time the truck or the transportation mode should take for rest at the stop.

Show Source

• object amountType

{
    "description":"The time the truck or the transportation mode should take for rest at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : rightWidthOog

Read Only: true

The right width-wise out of gauge.

Match All

The right width-wise out of gauge.

Show Source

• object amountType

{
    "description":"The right width-wise out of gauge.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningHeight

Read Only: true

The running total height from current stop to next stop.

Match All

The running total height from current stop to next stop.

Show Source

• object amountType

{
    "description":"The running total height from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningLength

Read Only: true

The running total length from current stop to next stop.

Match All

The running total length from current stop to next stop.

Show Source

• object amountType

{
    "description":"The running total length from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningWeight

Read Only: true

The running total weight from current stop to next stop.

Match All

The running total weight from current stop to next stop.

Show Source

• object amountType

{
    "description":"The running total weight from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : runningWidth

Read Only: true

The running total width from current stop to next stop.

Match All

The running total width from current stop to next stop.

Show Source

• object amountType

{
    "description":"The running total width from current stop to next stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ],
    "readOnly":true
}

Nested Schema : rushHourTime

The amount of time that the drive time defined on the stop in inside the rush hour window.

Match All

The amount of time that the drive time defined on the stop in inside the rush hour window.

Show Source

• object amountType

{
    "description":"The amount of time that the drive time defined on the stop in inside the rush hour window.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : voyage

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/voyages"
        }
    ],
    "readOnly":true
}

Nested Schema : waitTime

The time the truck or the transportation mode has to wait at the stop.

Match All

The time the truck or the transportation mode has to wait at the stop.

Show Source

• object amountType

{
    "description":"The time the truck or the transportation mode has to wait at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.debriefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• activity: string
  Specifies the activity (pickup, drop off) for the stop and the debrief values.
• domainName: string
  Database domain where this data is stored.
• item: item
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itemGid: string
  The item GID for the stop debrief.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• itemPackageCount: number (int64)
  The count of the package item count.
• links: array links
  Read Only: true
• matchType: string
  The match type code for linking the stop debrief data.
• nonConfReasonCodeGid: string
  The non conformance reason code GID associated with the stop debrief recording.
• orderReleaseLine: orderReleaseLine
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseLineGid: string
  The order release line GID linked to the stop debrief.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagingUnitCount: number (int64)
  The packaging unit count for the packing unit contained in the packaged item.
• packagingUnitGid: string
  The packaging unit GID for the packaging unit count that is contained in the packaged item.
• sequenceNo: string
  The sequence number (key).
• sEquipment: sEquipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sEquipmentGid: string
  The equipment GID linked to the stop debrief.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipUnitGid: string
  The ship unit GID linked to the stop debrief.
• sShipUnitGid: string
  The GID for ship unit for the shipment.
• sShipUnitLineNo: number (int64)
  The GID for ship unit line number for the shipment.
• transportHandlingUnitCount: number (int64)
  The transport handling count GID for the stop debrief.
• transportHandlingUnitGid: string
  The transport handling unit GID associated with the transport handling unit.

{
    "properties":{
        "activity":{
            "description":"Specifies the activity (pickup, drop off) for the stop and the debrief values.",
            "type":"string"
        },
        "sequenceNo":{
            "description":"The sequence number (key).",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"The GID for ship unit for the shipment.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"The GID for ship unit line number for the shipment.",
            "type":"number",
            "format":"int64"
        },
        "itemPackageCount":{
            "description":"The count of the package item count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"The packaging unit GID for the packaging unit count that is contained in the packaged item.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count for the packing unit contained in the packaged item.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit GID associated with the transport handling unit.",
            "type":"string"
        },
        "transportHandlingUnitCount":{
            "description":"The transport handling count GID for the stop debrief.",
            "type":"number",
            "format":"int64"
        },
        "itemGid":{
            "description":"The item GID for the stop debrief. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "item":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "nonConfReasonCodeGid":{
            "description":"The non conformance reason code GID associated with the stop debrief recording.",
            "type":"string"
        },
        "shipUnitGid":{
            "description":"The ship unit GID linked to the stop debrief.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The equipment GID linked to the stop debrief. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sEquipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sEquipments"
                }
            ],
            "readOnly":true
        },
        "matchType":{
            "description":"The match type code for linking the stop debrief data.",
            "type":"string"
        },
        "orderReleaseLineGid":{
            "description":"The order release line GID linked to the stop debrief. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderReleaseLine":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleaseLines"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : item

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderReleaseLine

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object orderReleaseLines

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleaseLines"
        }
    ],
    "readOnly":true
}

Nested Schema : sEquipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object sEquipments

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sEquipments"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• activity: string
  The activity performed at the stop. For example: pickup, delivery, etc.
• activityTime: activityTime
  The time spent performing the activity at the shipment stop.
• domainName: string
  Date and time of the most recent data update.
• involvedParties: involvedParties
• isPermanent: boolean
  A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.
• links: array links
  Read Only: true
• shipUnitDwellTime: shipUnitDwellTime
  The ship unit dwell time at the stop location as entered.
• sShipUnitGid: string
  A GID to define the shipment ship unit.
• sShipUnits: sShipUnits

{
    "properties":{
        "sShipUnitGid":{
            "description":"A GID to define the shipment ship unit.",
            "type":"string"
        },
        "activity":{
            "description":"The activity performed at the stop. For example: pickup, delivery, etc.",
            "type":"string"
        },
        "activityTime":{
            "description":"The time spent performing the activity at the shipment stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Date and time of the most recent data update.",
            "type":"string"
        },
        "shipUnitDwellTime":{
            "description":"The ship unit dwell time at the stop location as entered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "sShipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

The time spent performing the activity at the shipment stop.

Match All

The time spent performing the activity at the shipment stop.

Show Source

• object amountType

{
    "description":"The time spent performing the activity at the shipment stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipUnitDwellTime

The ship unit dwell time at the stop location as entered.

Match All

The ship unit dwell time at the stop location as entered.

Show Source

• object amountType

{
    "description":"The ship unit dwell time at the stop location as entered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : sShipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The communication method ID for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The contact ID for the involved party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The qualifier ID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier ID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact ID for the involved party. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method ID for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object sellShipments.stops.details.sShipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sellShipments.stops.details.sShipUnits

Type: object

Show Source

• accessorials: accessorials
• coreDiameter: coreDiameter
  For cylindrical objects, this defines the diameter of the core.
• domainName: string
  Database domain where this data is stored.
• earlyPickupDate: earlyPickupDate
  The early pickup date defined for the ship unit
• flexCommodityCode: string
  The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.
• flexCommodityQualGid: string
  A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.
• isAllowRepack: boolean
  If this flag is set to false, when planning order movement that contains this ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this ship unit.
• isCountSplittable: boolean
  Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.
• isFixedEruCount: boolean
  Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.
• isSplitable: boolean
  A true or false value to define whether the ship unit can be split when creating the shipments.
• lines: lines
• links: array links
  Read Only: true
• pieces: pieces
• priority: number (int32)
  Defines the priority associated with ship unit.
• rangeEnd: number (int32)
  The range end value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
• rangeStart: number (int32)
  The range start value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.
• receivedNetVolume: receivedNetVolume
  The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
• receivedNetWeight: receivedNetWeight
  The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
• receivedShipUnitCount: number (double)
  The received item package count. It can be entered as a stop debrief.
• receivedVolume: receivedVolume
  The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
• receivedWeight: receivedWeight
  The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.
• refnums: refnums
• releaseMethodGid: string
  The release method (order configuration identifier) associated with defining this ship unit. It specifies such attributes as if the ship unit weight is calculated from the ship unit line weight.
• remarks: remarks
• seals: seals
• sEquipments: sEquipments
• shipUnitCount: number (int64)
  Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. SHIP_UNIT_COUNT is the number of these ship units.
• shipUnitGid: string
  The GID for the order release ship unit that is associated to this shipment ship unit.
• specialServices: specialServices
• sShipUnitGid: string
  The GID for the ship unit associated to a shipment.
• sShipUnitXid: string
  The XID for the ship unit associated to a shipment.
• tag1: string
  A flexible field to contain informational data that has been copied from the order to the shipment.
• tag2: string
  A flexible field to contain informational data that has been copied from the order to the shipment.
• tag3: string
  A flexible field to contain informational data that has been copied from the order to the shipment.
• tag4: string
  A flexible field to contain informational data that has been copied from the order to the shipment.
• totalGrossVolume: totalGrossVolume
  The total gross volume of the shipment ship unit (transport handling unit + lines).
• totalGrossWeight: totalGrossWeight
  The total gross weight of the shipment ship unit (transport handling unit + lines).
• totalLoadingSplitVolume: totalLoadingSplitVolume
  Defines the total loading split volume if the ship unit can be split to load into the equipment.
• totalLoadingSplitWeight: totalLoadingSplitWeight
  Defines the total loading split weight if the ship unit can be split to load into the equipment.
• transportHandlingUnitGid: string
  The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
• tShipUnitGid: string
  A GID for the order release ship unit.
• unitDiameter: unitDiameter
  For cylindrical objects, this defines the diameter of the ship unit.
• unitHeight: unitHeight
  The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
• unitLength: unitLength
  The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
• unitNetVolume: unitNetVolume
  The unit net volume of the goods contained in the shipment ship unit.
• unitNetWeight: unitNetWeight
  The unit net weight of the goods contained in the shipment ship unit.
• unitVolume: unitVolume
  The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
• unitWeight: unitWeight
  The weight of the ship unit.
• unitWidth: unitWidth
  The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.

{
    "properties":{
        "sShipUnitGid":{
            "description":"The GID for the ship unit associated to a shipment.",
            "type":"string"
        },
        "sShipUnitXid":{
            "description":"The XID for the ship unit associated to a shipment.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.",
            "type":"string"
        },
        "unitLength":{
            "description":"The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitWidth":{
            "description":"The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitHeight":{
            "description":"The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitWeight":{
            "description":"The weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitVolume":{
            "description":"The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "flexCommodityCode":{
            "description":"The user-defined commodity code for the item. For example HTS, SITC, STCC, NMFC, etc.",
            "type":"string"
        },
        "flexCommodityQualGid":{
            "description":"A GID to define the type of the commodity code. For example HTS, SITC, STCC, NMFC etc.",
            "type":"string"
        },
        "isSplitable":{
            "description":"A true or false value to define whether the ship unit can be split when creating the shipments.",
            "type":"boolean"
        },
        "shipUnitCount":{
            "description":"Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. SHIP_UNIT_COUNT is the number of these ship units.",
            "type":"number",
            "format":"int64"
        },
        "earlyPickupDate":{
            "description":"The early pickup date defined for the ship unit",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "receivedWeight":{
            "description":"The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedShipUnitCount":{
            "description":"The received item package count. It can be entered as a stop debrief.",
            "type":"number",
            "format":"double"
        },
        "shipUnitGid":{
            "description":"The GID for the order release ship unit that is associated to this shipment ship unit.",
            "type":"string"
        },
        "unitNetWeight":{
            "description":"The unit net weight of the goods contained in the shipment ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitNetVolume":{
            "description":"The unit net volume of the goods contained in the shipment ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedNetWeight":{
            "description":"The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedNetVolume":{
            "description":"The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tag1":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag2":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag3":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag4":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tShipUnitGid":{
            "description":"A GID for the order release ship unit.",
            "type":"string"
        },
        "isCountSplittable":{
            "description":"Indicates whether the ship unit can be split on the count boundaries when planning during container optimization.",
            "type":"boolean"
        },
        "totalGrossWeight":{
            "description":"The total gross weight of the shipment ship unit (transport handling unit + lines).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalGrossVolume":{
            "description":"The total gross volume of the shipment ship unit (transport handling unit + lines).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "rangeStart":{
            "description":"The range start value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.",
            "type":"number",
            "format":"int32"
        },
        "rangeEnd":{
            "description":"The range end value associated with the ship unit to handle the case where the ship unit count is >1 signifying that there are multiple instances of this record.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "releaseMethodGid":{
            "description":"The release method (order configuration identifier) associated with defining this ship unit. It specifies such attributes as if the ship unit weight is calculated from the ship unit line weight.",
            "type":"string"
        },
        "isAllowRepack":{
            "description":"If this flag is set to false, when planning order movement that contains this ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this ship unit. ",
            "type":"boolean"
        },
        "totalLoadingSplitWeight":{
            "description":"Defines the total loading split weight if the ship unit can be split to load into the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalLoadingSplitVolume":{
            "description":"Defines the total loading split volume if the ship unit can be split to load into the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "priority":{
            "description":"Defines the priority associated with ship unit.",
            "type":"number",
            "format":"int32"
        },
        "isFixedEruCount":{
            "description":"Indicates whether the ERU defined on shipment ship unit is used or the ERU is derived from the order. A null value means N.",
            "type":"boolean"
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "sEquipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.sEquipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "lines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "pieces":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.pieces"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : coreDiameter

For cylindrical objects, this defines the diameter of the core.

Match All

For cylindrical objects, this defines the diameter of the core.

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the core.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : earlyPickupDate

The early pickup date defined for the ship unit

Match All

The early pickup date defined for the ship unit

Show Source

• object dateTimeType

{
    "description":"The early pickup date defined for the ship unit",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : pieces

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.pieces"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : receivedNetVolume

The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.

Match All

The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.

Show Source

• object amountType

{
    "description":"The received net volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedNetWeight

The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.

Match All

The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.

Show Source

• object amountType

{
    "description":"The received net weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedVolume

The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.

Match All

The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.

Show Source

• object amountType

{
    "description":"The received volume of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedWeight

The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.

Match All

The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.

Show Source

• object amountType

{
    "description":"The received gross weight of the shipment ship unit. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sEquipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.sEquipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalGrossVolume

The total gross volume of the shipment ship unit (transport handling unit + lines).

Match All

The total gross volume of the shipment ship unit (transport handling unit + lines).

Show Source

• object amountType

{
    "description":"The total gross volume of the shipment ship unit (transport handling unit + lines).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalGrossWeight

The total gross weight of the shipment ship unit (transport handling unit + lines).

Match All

The total gross weight of the shipment ship unit (transport handling unit + lines).

Show Source

• object amountType

{
    "description":"The total gross weight of the shipment ship unit (transport handling unit + lines).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalLoadingSplitVolume

Defines the total loading split volume if the ship unit can be split to load into the equipment.

Match All

Defines the total loading split volume if the ship unit can be split to load into the equipment.

Show Source

• object amountType

{
    "description":"Defines the total loading split volume if the ship unit can be split to load into the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalLoadingSplitWeight

Defines the total loading split weight if the ship unit can be split to load into the equipment.

Match All

Defines the total loading split weight if the ship unit can be split to load into the equipment.

Show Source

• object amountType

{
    "description":"Defines the total loading split weight if the ship unit can be split to load into the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitDiameter

For cylindrical objects, this defines the diameter of the ship unit.

Match All

For cylindrical objects, this defines the diameter of the ship unit.

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitHeight

The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.

Match All

The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.

Show Source

• object amountType

{
    "description":"The height of each shipment ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitLength

The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.

Match All

The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.

Show Source

• object amountType

{
    "description":"The length of each shipment ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitNetVolume

The unit net volume of the goods contained in the shipment ship unit.

Match All

The unit net volume of the goods contained in the shipment ship unit.

Show Source

• object amountType

{
    "description":"The unit net volume of the goods contained in the shipment ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitNetWeight

The unit net weight of the goods contained in the shipment ship unit.

Match All

The unit net weight of the goods contained in the shipment ship unit.

Show Source

• object amountType

{
    "description":"The unit net weight of the goods contained in the shipment ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitVolume

The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.

Match All

The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.

Show Source

• object amountType

{
    "description":"The volume of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitWeight

The weight of the ship unit.

Match All

The weight of the ship unit.

Show Source

• object amountType

{
    "description":"The weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitWidth

The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.

Match All

The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.

Show Source

• object amountType

{
    "description":"The width of each shipment ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this shipment ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code GID.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The accessorial code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• countPerShipUnit: number (int64)
  The count per ship unit.
• declaredValue: declaredValue
  The declared value of the packaged item quantity being shipped.
• domainName: string
  Database domain where this data is stored.
• hazmatItemGid: string
  The GID for the hazmat item.
• hotIndicator: boolean
  A Y/N indicator if the shipment line item is hot.
• itemPackageCount: number (int64)
  The number of packages in this shipment ship unit line for one ship unit. Its shipment ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each shipment ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
• links: array links
  Read Only: true
• loadConfigSetupGid: string
  A load configuration set up identifier to be used by the load configuration engine as the input rules during ship unit building during repack.
• marinePollutantIndicator: boolean
  A Y/N indicator if the shipment line item is a marine pollutant.
• orderBase: orderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderBaseGid: string
  Read Only: true

  The GID for the order base that is related to the shipment line.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  A unique identifier created by the system for the order release. The GID contains the domain portion.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• orLine: orLine
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orLineGid: string
  A unique identifier to define the multiple order release lines per order release. The GID has the domain portion.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The GID for the packaged item.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagingUnitCount: number (int64)
  The packaging unit count for the packaged unit that is being shipped.
• packagingUnitGid: string
  The GID for the packaging unit that is related to the shipment line.
• receivedCountPerShipUnit: number (int64)
  The received count per ship unit. It can be entered as stop debrief. Used for reporting purposes.
• receivedItemPackageCount: number (double)
  The received item package count. It can be entered as a stop debrief.
• receivedPackagingUnitCount: number (int64)
  The received packaging unit count of the shipment line. It can be entered as stop debrief. Used for reporting purposes.
• receivedVolume: receivedVolume
  The received volume of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.
• receivedWeight: receivedWeight
  The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.
• refnums: refnums
• remarks: remarks
• shipUnitGid: string
  The GID for the ship unit that contains this shipping line.
• shipUnitLineNo: number (int32)
  The ship unit line number defined for this shipping line.
• sShipUnitLineNo: number (int64)
  The unique sequence within the ship unit to define the individual line items.
• tOrderReleaseGid: string
  Used as a non-foreign key reference to the order release.
• tOrLineGid: string
  Used as a non-foreign key reference to the order release line.
• trackingTag1: string
  Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
• trackingTag2: string
  Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
• trackingTag3: string
  Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
• trackingTag4: string
  Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.
• tShipUnitGid: string
  Used as a non-foreign key reference to the order release ship unit line.
• tShipUnitLineNo: number (int32)
  Used as a non-foreign key reference to the order release ship unit line.
• userDefined1IconGid: string
  Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
• userDefined2IconGid: string
  Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
• userDefined3IconGid: string
  Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.
• userDefinedCommodityGid: string
  Read Only: true

  The user defined commodity identifier associated with the item that is being shipped.
• volume: volume
  The volume of the item.
• volumePer: volumePer
  The weight per shipping line count to handle shipping a multiple count.
• weight: weight
  The weight of the item.
• weightPer: weightPer
  The weight per shipping line count to handle shipping a multiple count.

{
    "properties":{
        "sShipUnitLineNo":{
            "description":"The unique sequence within the ship unit to define the individual line items.",
            "type":"number",
            "format":"int64"
        },
        "weight":{
            "description":"The weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "trackingTag1":{
            "description":"Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.",
            "type":"string"
        },
        "trackingTag2":{
            "description":"Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.",
            "type":"string"
        },
        "trackingTag3":{
            "description":"Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.",
            "type":"string"
        },
        "trackingTag4":{
            "description":"Additional information about the item. This could be any tracking numbers, SKU codes, SPLC codes etc.",
            "type":"string"
        },
        "orLineGid":{
            "description":"A unique identifier to define the multiple order release lines per order release. The GID has the domain portion. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orLine":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleaseLines"
                }
            ],
            "readOnly":true
        },
        "orderReleaseGid":{
            "description":"A unique identifier created by the system for the order release. The GID contains the domain portion. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "orderBaseGid":{
            "description":"The GID for the order base that is related to the shipment line. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string",
            "readOnly":true
        },
        "orderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit that is related to the shipment line.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count for the packaged unit that is being shipped.",
            "type":"number",
            "format":"int64"
        },
        "itemPackageCount":{
            "description":"The number of packages in this shipment ship unit line for one ship unit. Its shipment ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each shipment ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.",
            "type":"number",
            "format":"int64"
        },
        "declaredValue":{
            "description":"The declared value of the packaged item quantity being shipped.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packagedItemGid":{
            "description":"The GID for the packaged item. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "hazmatItemGid":{
            "description":"The GID for the hazmat item.",
            "type":"string"
        },
        "receivedWeight":{
            "description":"The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedItemPackageCount":{
            "description":"The received item package count. It can be entered as a stop debrief.",
            "type":"number",
            "format":"double"
        },
        "shipUnitGid":{
            "description":"The GID for the ship unit that contains this shipping line.",
            "type":"string"
        },
        "shipUnitLineNo":{
            "description":"The ship unit line number defined for this shipping line.",
            "type":"number",
            "format":"int32"
        },
        "weightPer":{
            "description":"The weight per shipping line count to handle shipping a multiple count.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volumePer":{
            "description":"The weight per shipping line count to handle shipping a multiple count.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "countPerShipUnit":{
            "description":"The count per ship unit.",
            "type":"number",
            "format":"int64"
        },
        "receivedPackagingUnitCount":{
            "description":"The received packaging unit count of the shipment line. It can be entered as stop debrief. Used for reporting purposes.",
            "type":"number",
            "format":"int64"
        },
        "receivedCountPerShipUnit":{
            "description":"The received count per ship unit. It can be entered as stop debrief. Used for reporting purposes.",
            "type":"number",
            "format":"int64"
        },
        "tOrderReleaseGid":{
            "description":"Used as a non-foreign key reference to the order release.",
            "type":"string"
        },
        "tOrLineGid":{
            "description":"Used as a non-foreign key reference to the order release line.",
            "type":"string"
        },
        "tShipUnitGid":{
            "description":"Used as a non-foreign key reference to the order release ship unit line.",
            "type":"string"
        },
        "tShipUnitLineNo":{
            "description":"Used as a non-foreign key reference to the order release ship unit line.",
            "type":"number",
            "format":"int32"
        },
        "userDefinedCommodityGid":{
            "description":"The user defined commodity identifier associated with the item that is being shipped.",
            "type":"string",
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Stores a user-defined icon that will appear within the user interface to help visually identify attributes for the ship unit line.",
            "type":"string"
        },
        "marinePollutantIndicator":{
            "description":"A Y/N indicator if the shipment line item is a marine pollutant.",
            "type":"boolean"
        },
        "hotIndicator":{
            "description":"A Y/N indicator if the shipment line item is hot.",
            "type":"boolean"
        },
        "loadConfigSetupGid":{
            "description":"A load configuration set up identifier to be used by the load configuration engine as the input rules during ship unit building during repack.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

The declared value of the packaged item quantity being shipped.

Match All

The declared value of the packaged item quantity being shipped.

Show Source

• object currencyType

{
    "description":"The declared value of the packaged item quantity being shipped.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : orLine

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object orderReleaseLines

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleaseLines"
        }
    ],
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : receivedVolume

The received volume of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.

Match All

The received volume of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.

Show Source

• object amountType

{
    "description":"The received volume of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedWeight

The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.

Match All

The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.

Show Source

• object amountType

{
    "description":"The received weight of the shipment line. It can be entered as a stop debrief. Used for reporting purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The volume of the item.

Match All

The volume of the item.

Show Source

• object amountType

{
    "description":"The volume of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volumePer

The weight per shipping line count to handle shipping a multiple count.

Match All

The weight per shipping line count to handle shipping a multiple count.

Show Source

• object amountType

{
    "description":"The weight per shipping line count to handle shipping a multiple count.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight of the item.

Match All

The weight of the item.

Show Source

• object amountType

{
    "description":"The weight of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weightPer

The weight per shipping line count to handle shipping a multiple count.

Match All

The weight per shipping line count to handle shipping a multiple count.

Show Source

• object amountType

{
    "description":"The weight per shipping line count to handle shipping a multiple count.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• refnumValue: string
  The text associated to the remark code.
• sSulRefnumQualGid: string
  The reference number qualifier identifier defining the reference code.

{
    "properties":{
        "sSulRefnumQualGid":{
            "description":"The reference number qualifier identifier defining the reference code.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.lines.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the shipment.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the shipment.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object sellShipments.stops.details.sShipUnits.pieces

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.pieces"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sellShipments.stops.details.sShipUnits.pieces

Type: object

Show Source

• domainName: string
  No description.
• height: height
  No description.
• isSplit: boolean
  To indicate if this is a loading split from the original SSU.
• length: length
  No description.
• links: array links
  Read Only: true
• loadConfig3dPatternGid: string
  Corresponding user defined 3d pattern. If the piece is placed using user defined 3d pattern, this indicates the pattern used.
• loadingSequence: number (int32)
  The loading sequence of the SSU singleton.
• orientationGid: string
  Orientation of the ship unit piece.
• patternInstanceCount: number (int32)
  Instance of the user pattern used
• pieceNumber: number (int32)
  A unique number given to a piece of SSU for the same S_SHIP_UNIT_GID with multiple counts.
• stackingLayer: number (int32)
  Stacking layers of the unit. If multiple units are underneath, this is the maximum number of layers underneath added by 1.
• totalTopWeight: totalTopWeight
  This is the summation of all weights on the top distributed according to the area touching the pieces
• volume: volume
  No description.
• weight: weight
  No description.
• width: width
  No description.
• xCoordinate: xCoordinate
  The x-coordinate of the unit using container's front lower left corner as the origin.
• yCoordinate: yCoordinate
  The y-coordinate of the unit using container's front lower left corner as the origin.
• zCoordinate: zCoordinate
  The z-coordinate of the unit using container's front lower left corner as the origin.

{
    "properties":{
        "pieceNumber":{
            "description":"A unique number given to a piece of SSU for the same S_SHIP_UNIT_GID with multiple counts.",
            "type":"number",
            "format":"int32"
        },
        "loadingSequence":{
            "description":"The loading sequence of the SSU singleton.",
            "type":"number",
            "format":"int32"
        },
        "stackingLayer":{
            "description":"Stacking layers of the unit. If multiple units are underneath, this is the maximum number of layers underneath added by 1.",
            "type":"number",
            "format":"int32"
        },
        "orientationGid":{
            "description":"Orientation of the ship unit piece.",
            "type":"string"
        },
        "xCoordinate":{
            "description":"The x-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "yCoordinate":{
            "description":"The y-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "zCoordinate":{
            "description":"The z-coordinate of the unit using container's front lower left corner as the origin.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "totalTopWeight":{
            "description":"This is the summation of all weights on the top distributed according to the area touching the pieces",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplit":{
            "description":"To indicate if this is a loading split from the original SSU.",
            "type":"boolean"
        },
        "length":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "loadConfig3dPatternGid":{
            "description":"Corresponding user defined 3d pattern. If the piece is placed using user defined 3d pattern, this indicates the pattern used.",
            "type":"string"
        },
        "patternInstanceCount":{
            "description":"Instance of the user pattern used",
            "type":"number",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : height

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : totalTopWeight

This is the summation of all weights on the top distributed according to the area touching the pieces

Match All

This is the summation of all weights on the top distributed according to the area touching the pieces

Show Source

• object amountType

{
    "description":"This is the summation of all weights on the top distributed according to the area touching the pieces",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volume

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

No description.

Match All

No description.

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : xCoordinate

The x-coordinate of the unit using container's front lower left corner as the origin.

Match All

The x-coordinate of the unit using container's front lower left corner as the origin.

Show Source

• object amountType

{
    "description":"The x-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : yCoordinate

The y-coordinate of the unit using container's front lower left corner as the origin.

Match All

The y-coordinate of the unit using container's front lower left corner as the origin.

Show Source

• object amountType

{
    "description":"The y-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : zCoordinate

The z-coordinate of the unit using container's front lower left corner as the origin.

Match All

The z-coordinate of the unit using container's front lower left corner as the origin.

Show Source

• object amountType

{
    "description":"The z-coordinate of the unit using container's front lower left corner as the origin.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• refnumValue: string
  The text associated to the remark code.
• sShipUnitRefnumQualGid: string
  The reference number qualifier identifier defining the reference code.

{
    "properties":{
        "sShipUnitRefnumQualGid":{
            "description":"The reference number qualifier identifier defining the reference code.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the shipment.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the shipment.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentSeal: string
  The equipment seal number for the shipment ship unit.
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentSeal":{
            "description":"The equipment seal number for the shipment ship unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.sEquipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• compartmentNum: number (int32)
  The number associated with the compartment in a multi-compartment equipment. (View Only)
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• loadingPatternGid: string
  The loading pattern used to place ship unit into equipment if load configuration algorithm used is pattern based. (View Only)
• loadingSequence: number (int32)
  The sequence that the shipment ship unit is loaded into the equipment. (View Only)
• numLoadingRows: number (int32)
  The number associated with the row the ship unit is placed in. (View Only)
• numStackingLayers: number (int32)
  The number associated with the layer stacked for ship unit. (View Only)
• sEquipment: sEquipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sEquipmentGid: string
  The GID for the shipment equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "sEquipmentGid":{
            "description":"The GID for the shipment equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sEquipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sEquipments"
                }
            ],
            "readOnly":true
        },
        "compartmentNum":{
            "description":"The number associated with the compartment in a multi-compartment equipment. (View Only)",
            "type":"number",
            "format":"int32"
        },
        "loadingSequence":{
            "description":"The sequence that the shipment ship unit is loaded into the equipment. (View Only) ",
            "type":"number",
            "format":"int32"
        },
        "loadingPatternGid":{
            "description":"The loading pattern used to place ship unit into equipment if load configuration algorithm used is pattern based. (View Only) ",
            "type":"string"
        },
        "numStackingLayers":{
            "description":"The number associated with the layer stacked for ship unit. (View Only)",
            "type":"number",
            "format":"int32"
        },
        "numLoadingRows":{
            "description":"The number associated with the row the ship unit is placed in. (View Only)",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : sEquipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object sEquipments

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sEquipments"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.details.sShipUnits.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The special service identifier defining the service to be performed.

{
    "properties":{
        "specialServiceGid":{
            "description":"The special service identifier defining the service to be performed.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The communication method for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The contact ID for the involved party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The qualifier ID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier ID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact ID for the involved party. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentStopRefnumQualGid: string
  The shipment reference qualifier GID defining the reference type.
• shipmentStopRefnumValue: string
  The shipment stop reference value.

{
    "properties":{
        "shipmentStopRefnumQualGid":{
            "description":"The shipment reference qualifier GID defining the reference type.",
            "type":"string"
        },
        "shipmentStopRefnumValue":{
            "description":"The shipment stop reference value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.stops.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
• remarkSequence: number (int64)
  The sequence (key) for the remark.
• remarkText: string
  User entered remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence (key) for the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: Service provider assigned equipment number,  service provider tender decline reason code, etc.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• arrRegionName: string
  The voyage's Departure Region name and Arrival Region name are for information only. The Departure and Arrival information is intended to hold the trade lane level description of the voyage e.g., Asia to North America, Middle East to Europe.
• dataSourcePartitionKey: number (double)
  Partition key used to parse the data based on the data source.
• depDate: depDate
  The departure date for the voyage.
• depRegionName: string
  The name of the departure region for the voyage.
• domainName: string
  Database domain where this data is stored.
• insertDate: insertDate
  Read Only: true

  insert date
• isComposite: boolean
  Check box used to identify voyages that are composite voyages i.e., the voyage has a transload point.
  Composite Voyages - A composite voyage is a voyage that takes place using two or more vessels. The main vessel is the 'mother' vessel and can be identified as such when creating a voyage. This enables you to identify which feeder was from the source port and what is the mother vessel discharging at the destination port on the shipment.
  A shipment's last departure stop must be before voyage's first transload stop.
  A shipment's first arrival stop must be after voyage's last transload stop.
  If a transload shipment has a composite voyage, then it will find all transload stops on its voyage and insert them as transload stops on the shipment. The times from the voyage are copied to shipment stops.
  If there are multiple transload stops in a voyage, then all the transload stops should be together in the middle of voyage stops.
• links: array links
  Read Only: true
• locations: locations
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The GID for the service provider for the voyage.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprovProfileGid: string
  The GID for the service provider profile. The service provider profile is on the voyage to support scenarios where multiple ocean carriers have a vessel sharing agreement.
• timeStamp: timeStamp
  Time the record was added.
• updateDate: updateDate
  Read Only: true

  update date
• vesselGid: string
  The GID for the vessel assigned to the voyage. The vessel record contains important information about the vessel like: Owner, Operator, Registry Port, Flag Country, Official Number.
• voyageGid: string
  The GID for the voyage.
• voyageName: string
  The name of the voyage.
• voyageServiceTypeGid: string
  The GID for the voyage service type. The Voyage Service Type links the voyage with a rate service and rate. The Voyage Service Type ID identifies the voyage service type which must be assigned to at least one rate service. Each voyage schedule must have a voyage service type that is associated with at least one rate service for it to be considered for a shipment.
• voyageXid: string
  The unique external identifier for the voyage.

{
    "properties":{
        "voyageGid":{
            "description":"The GID for the voyage.",
            "type":"string"
        },
        "voyageXid":{
            "description":"The unique external identifier for the voyage.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the service provider for the voyage. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "voyageServiceTypeGid":{
            "description":"The GID for the voyage service type. The Voyage Service Type links the voyage with a rate service and rate. The Voyage Service Type ID identifies the voyage service type which must be assigned to at least one rate service. Each voyage schedule must have a voyage service type that is associated with at least one rate service for it to be considered for a shipment.",
            "type":"string"
        },
        "vesselGid":{
            "description":"The GID for the vessel assigned to the voyage. The vessel record contains important information about the vessel like: Owner, Operator, Registry Port, Flag Country, Official Number.",
            "type":"string"
        },
        "voyageName":{
            "description":"The name of the voyage.",
            "type":"string"
        },
        "depRegionName":{
            "description":"The name of the departure region for the voyage.",
            "type":"string"
        },
        "arrRegionName":{
            "description":"The voyage's Departure Region name and Arrival Region name are for information only. The Departure and Arrival information is intended to hold the  trade lane level description of the voyage e.g., Asia to North America,  Middle East to Europe.",
            "type":"string"
        },
        "depDate":{
            "description":"The departure date for the voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "timeStamp":{
            "description":"Time the record was added.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dataSourcePartitionKey":{
            "description":"Partition key used to parse the data based on the data source.",
            "type":"number",
            "format":"double"
        },
        "servprovProfileGid":{
            "description":"The GID for the service provider profile. The service provider profile is on the voyage to support scenarios where multiple ocean carriers have a vessel sharing agreement.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isComposite":{
            "description":"Check box used to identify voyages that are composite voyages i.e., the voyage has a transload point. <br>Composite Voyages -  A composite voyage is a voyage that takes place using two or more vessels. The main vessel is the 'mother' vessel  and can be identified as such when creating a voyage. This enables you to identify which feeder was from the source port and what is the mother vessel discharging at the destination port on the shipment.<br>A shipment's last departure stop must be before voyage's first transload stop.<br>A shipment's first arrival stop must be after voyage's last transload stop.<br>If a transload shipment has a composite voyage, then it will find all transload stops on its voyage and insert them as transload stops on the shipment. The times from the voyage are copied to shipment stops.<br>If there are multiple transload stops in a voyage, then all the transload stops should be together in the middle of voyage stops.",
            "type":"boolean"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "locations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/voyages.locations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : depDate

The departure date for the voyage.

Match All

The departure date for the voyage.

Show Source

• object dateTimeType

{
    "description":"The departure date for the voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : locations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/voyages.locations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : timeStamp

Time the record was added.

Match All

Time the record was added.

Show Source

• object dateTimeType

{
    "description":"Time the record was added.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/voyages.locations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• actualDOrADate: actualDOrADate
  The actual date at port sometimes sent by carrier.
• dataSourcePartitionKey: number (double)
  Partition key used to parse the data based on the data source.
• domainName: string
  Database domain where this data is stored.
• dOrA: string
  Defines whether the location is a pickup (D) or delivery (A) point for the voyage.
• dOrADate: dOrADate
  The date for the pickup (D) or delivery (A) for the voyage.
• estimatedDOrADate: estimatedDOrADate
  The estimated date at port sometimes sent by a carrier.
• isMotherVessel: boolean
  You can select the Mother check box to indicate that this is the mother vessel or "vessel of record" for the leg for customs.
• isTransload: boolean
  For composite voyages. The transload point check box identifies the transload port in the rotation. The Transload check box is used by OTM to indicate a transload stop (the stop type will be "T" for transload.)
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  The GID for the location of the voyage.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• seqNo: number (int32)
  The sequence number for the location of the voyage.
• vesselDescription: string
  The Vessel Description field is for further information about the vessel for the leg. It is for information only.
• voyageDescription: string
  The Voyage Description field is the voyage of the operator of the leg. This is for information only and is not a validated field.
• voyageServiceTypeGid: string
  The GID for the voyage service type. The Voyage Service Type ID field is the voyage service type of the operator of the leg. It is a validated field but is only used for information and documentation. The Voyage Service Type ID on the header is operational and used to link the voyage to the rate service. The voyage service type of the mother vessel should be the voyage service type on the header.

{
    "properties":{
        "seqNo":{
            "description":"The sequence number for the location of the voyage.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"The GID for the location of the voyage. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "dOrA":{
            "description":"Defines whether the location is a pickup (D) or delivery (A) point for the voyage.",
            "type":"string"
        },
        "dOrADate":{
            "description":"The date for the pickup (D) or delivery (A) for the voyage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "estimatedDOrADate":{
            "description":"The estimated date at port sometimes sent by a carrier.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "actualDOrADate":{
            "description":"The actual date at port sometimes sent by carrier.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dataSourcePartitionKey":{
            "description":"Partition key used to parse the data based on the data source.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "isTransload":{
            "description":"For composite voyages. The transload point check box identifies the transload port in the rotation. The Transload check box is used by OTM to indicate a transload stop (the stop type will be \"T\" for transload.)",
            "type":"boolean"
        },
        "voyageServiceTypeGid":{
            "description":"The GID for the voyage service type. The Voyage Service Type ID field is the voyage service type of the operator of the leg. It is a validated field but is only used for information and documentation. The Voyage Service Type ID on the header is operational and used to link the voyage to the rate service. The voyage service type of the mother vessel should be the voyage service type on the header.",
            "type":"string"
        },
        "voyageDescription":{
            "description":"The Voyage Description field is the voyage of the operator of the leg. This is for information only and is not a validated field.",
            "type":"string"
        },
        "vesselDescription":{
            "description":"The Vessel Description field is for further information about the vessel for the leg. It is for information only.",
            "type":"string"
        },
        "isMotherVessel":{
            "description":"You can select the Mother check box to indicate that this is the mother vessel or \"vessel of record\" for the leg for customs.",
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualDOrADate

The actual date at port sometimes sent by carrier.

Match All

The actual date at port sometimes sent by carrier.

Show Source

• object dateTimeType

{
    "description":"The actual date at port sometimes sent by carrier.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : dOrADate

The date for the pickup (D) or delivery (A) for the voyage.

Match All

The date for the pickup (D) or delivery (A) for the voyage.

Show Source

• object dateTimeType

{
    "description":"The date for the pickup (D) or delivery (A) for the voyage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : estimatedDOrADate

The estimated date at port sometimes sent by a carrier.

Match All

The estimated date at port sometimes sent by a carrier.

Show Source

• object dateTimeType

{
    "description":"The estimated date at port sometimes sent by a carrier.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sellShipments.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  A document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The foreign key to the text template table, in order to include fixed text with this shipment.

{
    "properties":{
        "textTemplateGid":{
            "description":"The foreign key to the text template table, in order to include fixed text with this shipment.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"A document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.allocations.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release line record.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based Shipment.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher or invoice

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release line record.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based Shipment.",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher or invoice",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.attributes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemFeatureQualGid: string
  The item feature qualifier GID defining what type of feature with which this value is associated.
• itemFeatureValue: string
  The item feature value for the order release line. This allows for future structural definition of an item such as size and color.
• links: array links
  Read Only: true

{
    "properties":{
        "itemFeatureQualGid":{
            "description":"The item feature qualifier GID defining what type of feature with which this value is associated.",
            "type":"string"
        },
        "itemFeatureValue":{
            "description":"The item feature value for the order release line. This allows for future structural definition of an item such as size and color.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.equipmentRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The equipment reference unit GID for the order line.
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of ref units per package for the equipment reference unit GID on this line.
• totalNumReferenceUnits: number (double)
  The total number of reference units for the equipment reference unit on this line.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference unit GID for the order line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The number of ref units per package for the equipment reference unit GID on this line.",
            "type":"number",
            "format":"double"
        },
        "totalNumReferenceUnits":{
            "description":"The total number of reference units for the equipment reference unit on this line.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The communication method ID for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The contact ID for the involved party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The qualifier ID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier ID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact ID for the involved party. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method ID for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.packageRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The packaging reference unit GID. The package reference unit (PRU) defines another dimension to describe the consumption and capacity associated to building the order release ship units for transport. An example could be value of goods, loading meters, etc.
• totalPruCount: number (double)
  The total packaging unit reference (PRU) count being described as how much of the PRU does this line consume against the upper limit.
• unitPruCount: number (double)
  The packaging unit reference (PRU) count being described as how much of the PRU does this line consume.

{
    "properties":{
        "packagingReferenceUnitGid":{
            "description":"The packaging reference unit GID. The package reference unit (PRU) defines another dimension to describe the consumption and capacity associated to building the order release ship units for transport. An example could be value of goods, loading meters, etc.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "unitPruCount":{
            "description":"The packaging unit reference (PRU) count being described as how much of the PRU does this line consume.",
            "type":"number",
            "format":"double"
        },
        "totalPruCount":{
            "description":"The total packaging unit reference (PRU) count being described as how much of the PRU does this line consume against the upper limit.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• orderReleaseRefnumQualGid: string
  The reference number qualifier GID defining the reference code.
• orlRefnumValue: string
  The text associated to the remark code.

{
    "properties":{
        "orderReleaseRefnumQualGid":{
            "description":"The reference number qualifier GID defining the reference code.",
            "type":"string"
        },
        "orlRefnumValue":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier GID defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the order base line.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the order base line.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier GID defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceCodeGid: string
  The special service code GID.

{
    "properties":{
        "specialServiceCodeGid":{
            "description":"The special service code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleaseLines.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  A document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  The transactional override for the template on the specific document.
• textTemplateGid: string
  The text template qualifier GID defining the text.

{
    "properties":{
        "textTemplateGid":{
            "description":"The text template qualifier GID defining the text.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"A document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"The transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.orderReleaseDetails.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, or remark type.
• remarkSequence: number (int64)
  The one-up number to make the remark record unique.
• remarkText: string
  User entered remark on the shipment group order release

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark record unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark on the shipment group order release",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• shipGroupRefnumQualGid: string
  Reference qualiifer.
• shipGroupRefnumValue: string
  Reference value.

{
    "properties":{
        "shipGroupRefnumQualGid":{
            "description":"Reference qualiifer.",
            "type":"string"
        },
        "shipGroupRefnumValue":{
            "description":"Reference value.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, or remark type.
• remarkSequence: number (int64)
  The one-up number to make the remark record unique.
• remarkText: string
  User entered remark on the shipment group.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark record unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark on the shipment group.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipmentGroups.secondaryCharges

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.secondaryCharges"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipmentGroups.secondaryCharges

Type: object

Show Source

• actualCo2Emission: actualCo2Emission
  Actual CO2 emissions for the shipment.
• actualCo2EqEmission: actualCo2EqEmission
  Actual CO2 equivalent emissions for the shipment.
• aheadLateTime: aheadLateTime
  shipment status
• aheadOrLate: string
  A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user. B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed
• airRailRouteCode: string
  A transportation mode code that is informational for the shipment.
• appointmentPriorityGid: string
  The appointment priority identifier associated with the shipment.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeCurrency2: attributeCurrency2
  The attribute currency of the shipment.
• attributeCurrency3: attributeCurrency3
  The attribute currency of the shipment.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• bolIssuanceType: string
  The bill of lading issuance type identifier.
• bolType: string
  The bill of lading type defined for the shipment, used for report management.
• bulkCmGid: string
  The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.
• bulkPlanGid: string
  If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.
• cfsCutoffDate: cfsCutoffDate
  The container freight station cutoff date associated with the shipment.
• cfsLocation: cfsLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cfsLocationGid: string
  The location identifier for the container freight station.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• chargeableVolume: chargeableVolume
  The actual volume used in calculating the cost of the shipment.
• chargeableWeight: chargeableWeight
  The dimensional weight as determined by the rating process.
• checkCapacityConstraint: boolean
  The indicator to check the capacity constraints associated with the shipment.
• checkCostConstraint: boolean
  The indicator to check cost constraints associated with the shipment
• checkTimeConstraint: boolean
  The indicator to check the time constraints associated with the shipment.
• cmCost: cmCost
  The shipment cost when the shipment is part of a continuous move tour.
• cmEmptyDistance: cmEmptyDistance
  The empty leg distance between previous and this shipments.
• cmName: string
  The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.
• cmNextSourceLocation: cmNextSourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cmNextSourceLocationGid: string
  The source location of the next shipment in the continuous move tour.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• cmPrevDestLocation: cmPrevDestLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• cmPrevDestLocationGid: string
  The destination location of the previous shipment in the continuous move tour.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• cmSequenceNum: number (int32)
  Indicates the shipment's sequence in the continuous move tour.
• cofcTofc: string
  The trailer or flat car or the container on flat car code for rail shipments.
• combinationEquipGrp: combinationEquipGrp
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• combinationEquipGrpGid: string
  The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• consol: consol
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• consolGid: string
  The consol identifier if the shipment has been built from a consol structure.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• contact: contact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• contactGid: string
  The contact identifier linking in the contact table information to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• containerDeliveryLoc: containerDeliveryLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• containerDeliveryLocGid: string
  The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• containerPickupLoc: containerPickupLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• containerPickupLocGid: string
  The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• currencyGid: string
  Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.
• currentStopNum: number (int32)
  The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.
• customerRateCode: string
  The customer rate identifier associated with the shipment if this shipment is planned using a customer.
• deliveringServprov: deliveringServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• deliveringServprovGid: string
  The service provider who is the delivering service provider for this shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• destArbLevelOfServiceGid: string
  The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.
• destLocation: destLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destLocationGid: string
  The GID of the destination location of the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• destLocationOverrideGid: string
  The location identifier that will override the destination location that is defined for the shipment.
• destPierLocation: destPierLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destPierLocationGid: string
  The destination operational location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dimVolume: dimVolume
  The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.
• dimWeight: dimWeight
  The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.
• domainName: string
  The database domain where this data is stored.
• driver: driver
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• driverAssignBulkPlanGid: string
  Fleet bulk plan ID for driver assignment.
• driverGid: string
  The driver or primary team driver assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• dropInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for dropping an empty equipment after freight.
• dutyPaid: string
  The duty paid of the shipment.
• earliestStartTime: earliestStartTime
  The earliest start time that will make this shipment feasible.
• emPhoneNumber: string
  The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.
• endTime: endTime
  The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.
• equipmentAssignBulkPlanGid: string
  Fleet bulk plan ID for equipment assignment.
• equipmentDestination: string
  equipment destination
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentDestinationRefObject: equipmentDestinationRefObject
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
  This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.
• equipmentReferenceUnitGid: string
  The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.
• equipRefUnitUtilization: number (double)
  The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.
• etaDate: etaDate
  Estimated time of arrival
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• externalVoyageCode: string
  Specifies the number of the voyage as assigned by the carrier that transports the shipment.
• feasibilityCodeGid: string
  The feasibility code associated with the shipment can identify shipment infeasibilities.
• firstEquipmentGroupGid: string
  A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.
• firstEquipmentInitial: string
  first equipment intial
• firstEquipmentNumber: string
  first equipment number
• fixedServiceDays: number (int32)
  The fixed number of service days, if returned by the rating engine.
• flightInstanceId: number (int64)
  The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.
• freightTerms: string
  The freight terms for the shipment, such as prepaid or collect.
• hasAppointments: boolean
  Indicates if any stops on the shipment have appointments.
• hazmatModeGid: string
  The hazmat mode identifier that is associated with the shipment.
• hazmatRegionGid: string
  The hazmat region identifier that is associated with the shipment.
• incoTermGid: string
  The Incoterm identifier associated with the shipment.
• insuranceAmount: insuranceAmount
  The insurance amount of the shipment.
• insurancePolicyNumber: string
  The insurance policy number that covers this shipment, for informational purposes.
• insurancePremium: insurancePremium
  The insurance premium of the shipment, for informational purposes.
• intermediaryCorporation: intermediaryCorporation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• intermediaryCorporationGid: string
  The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• inTrailerBuild: boolean
  Indicates that this shipment is in a trailer build shipment group.
• isAdvancedCharge: boolean
  A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.
• isArRouteCodeFixed: boolean
  This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.
• isAutoMergeConsolidate: boolean
  Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)
• isCostFixed: boolean
  A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.
• isCpctyOverrideApplicable: boolean
  A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.
• isCreditNote: boolean
  Y/N based on an associated credit note.
• isEquipmentFixed: boolean
  Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.
• isFixedDistance: boolean
  Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.
• isFixedTenderContact: boolean
  A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.
• isFixedVoyage: boolean
  A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.
• isHazardous: boolean
  A Y/N indicator specifying that the shipment is identified as having hazardous material.
• isMemoBl: boolean
  Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.
• isPermanent: boolean
  Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in "delete shipment" action.
• isPreferredCarrier: boolean
  Indicates if the carrier selected for the shipment is preferred.
• isPreload: boolean
  A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.
• isPrimary: boolean
  Indicates if the shipment is the primary shipment related to an order (bookings) path.
• isProfitSplit: boolean
  Indicates if the NFRC shipment will be profit split.
• isRateGeoFixed: boolean
  A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.
• isRateOfferingFixed: boolean
  A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.
• isRecalcTotals: boolean
  Turns on/off totaling logic.
• isServiceTimeFixed: boolean
  A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.
• isServprovFixed: boolean
  A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.
• isSpotCosted: boolean
  Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.
• isTemperatureControl: boolean
  A Y/N indicator specifying that the shipment is identified as needing temperature control.
• isTemplate: boolean
  Indicates whether a shipment is a template.
• isToBeHeld: boolean
  A Y/N indicator specifying that the shipment is to be held by the carrier.
• itinerary: itinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itineraryGid: string
  The itinerary identifier that was used to build the shipment if it was built with the planning logic.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• jobGid: string
  The job GID identifier of the shipment, if the shipment is assigned to a job.
• lastEventGroupGid: string
  The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.
• latestStartTime: latestStartTime
  The latest start time that will make this shipment feasible.
• links: array links
  Read Only: true
• loadConfigEngineTypeGid: string
  Null type means no load configuration is performed on the shipment.
• loadedDistance: loadedDistance
  The total distance that the truck or the transportation mode will travel when the shipment is loaded.
• loadingHallPenalty: number (double)
  The loading hall penalty used while building loading halls for the shipment.
• marketCost: marketCost
  Market cost based on the shipment.
• maxNumRetender: number (int32)
  Maximum number of re-tenders.
• nfrcRuleGid: string
  The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.
• numEquipmentOrdered: number (int32)
  The number of equipment ordered. This is manually set by the user and can be rated on.
• numOrderReleases: number (int32)
  The number of order releases that are on this shipment.
• numStops: number (int32)
  The number of shipment stop records related to this shipment.
• originalInvoiceCost: originalInvoiceCost
  The original invoice cost at the point when the invoice was initially created or matched to the shipment.
• originalShipmentGid: string
  If the shipment represents a secondary charge, this points back to the "parent" shipment for which the secondary shipment is a "child".
• originatingServprov: originatingServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• originatingServprovGid: string
  The service provider who is the originating service provider for this shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• parcelZone: string
  The ship to mail zone. A price key used for parcel rate calculations.
• parentLegGid: string
  The parent leg associated with the itinerary that may have been used to plan the shipment.
• paymentMethodCodeGid: string
  The payment method code identifier.
• perspective: string
  The indicates if the shipment is a buy or sell perspective.
• pickInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for picking an empty equipment before freight.
• placeDeliverLocation: placeDeliverLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• placeDeliverLocationGid: string
  The place deliver location identifier specifying the location where ownership of freight ends with delivery.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• placeReceiptLocation: placeReceiptLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• placeReceiptLocationGid: string
  The place receipt location identifier specifying the location where ownership of freight starts.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• plannedCo2Emission: plannedCo2Emission
  CO2 emissions recorded while planning the shipment.
• plannedCo2EqEmission: plannedCo2EqEmission
  CO2 equivalent emissions recorded while planning the shipment.
• plannedCost: plannedCost
  The cost when the original shipment was created.
• plannedRateGeoGid: string
  The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedRateOfferingGid: string
  The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• plannedServprov: plannedServprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• plannedServprovGid: string
  The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• plannedTransportModeGid: string
  The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.
• planningParameterSetGid: string
  The parameter set GID which is used in building this shipment.
• portDischargeEta: portDischargeEta
  The estimated port of discharge date associated with ocean-going shipments.
• portExitLoc: portExitLoc
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portExitLocGid: string
  The designated port the freight will be exiting the country for international shipments.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfDisLocation: portOfDisLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfDisLocationGid: string
  The location ID of the port of discharge for the primary leg carrier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfDisOverrideLocGid: string
  The location override ID of the port of discharge for the primary leg carrier.
• portOfExitDate: portOfExitDate
  The estimated port of exit (for international shipments) associated with ocean going shipments.
• portOfLoadLocation: portOfLoadLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• portOfLoadLocationGid: string
  The location ID of the port of load for the primary leg carrier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• portOfLoadOverrideLocGid: string
  The location override ID of the port of load for the primary leg carrier.
• powerUnit: powerUnit
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• powerUnitGid: string
  The power unit assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• prevDropInventoryProcessed: boolean
  Indicates fleet equipment inventory processing for driver's previous shipment's equipment.
• prevEquipmentDestination: string
  previous equipment destination
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• prevEquipmentDestinationRefObject: prevEquipmentDestinationRefObject
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
  This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.
• prevReportedBsStatusCode: string
  previous reported event for shipment
• prevReportingScac: string
  previous reporting scac
• prevSightingDate: prevSightingDate
  The date associated with the previous sighting location and in the tracking event.
• prevSightingLocation: prevSightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• prevSightingLocationGid: string
  The location identifier for the previous sighting location used for rail shipment and tracking events.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• primaryOrderBase: primaryOrderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• primaryOrderBaseGid: string
  A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• processingCodeGid: string
  The processing code GID.
• projectedTourName: string
  Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.
• projectedTourSequenceNum: number (int32)
  Represents the sequence in which the shipment should appear in the projected tour.
• railDate: railDate
  The rail date of the shipment that is populated if the shipment utilizes the rail schedules.
• railInterModalPlanGid: string
  The rail intermodal plan identifier of the shipment used for intermodal rail shipments.
• railReturnLocation: railReturnLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• railReturnLocationGid: string
  The rail return location identifier of the rail shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• railReturnRouteGid: string
  The rail return route identifier of the rail shipment.
• rateGeoGid: string
  The detailed rate record (contract) identifier that is used by the service provider moving this shipment.
• rateOfferingGid: string
  The rate offering (contract) identifier that is used by the service provider moving this shipment.
• repetitionScheduleGid: string
  The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.
• reportedBsStatusCode: string
  latest reported event for shipment
• reportingScac: string
  reporting scac
• reservationNum: string
  Saved here to search shipments based on Reservation Number.
• routeCodeCombinationGid: string
  The route code combination identifier of the shipment used for specifying rail shipments.
• rule11Indicator: string
  The rule 11 indicator of the shipment used for managing rail.
• rule7: boolean
  A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.
• sailCutoffDate: sailCutoffDate
  The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.
• sailDate: sailDate
  The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.
• scheduleType: string
  When the schedule type is populated, it is a consol.
• secondaryChargeRuleGid: string
  The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.
• secondaryDriver: secondaryDriver
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• secondaryDriverGid: string
  The secondary team driver assigned to the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The service provider identifier associated with the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentAsWork: boolean
  Indicates the shipment as work.
• shipmentGid: string
  The GID for the shipment.
• shipmentName: string
  A descriptive name of the shipment.
• shipmentReleased: boolean
  A Y/N indicator used for rail shipments that indicate that the shipment is ready.
• shipmentTypeGid: string
  The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.
• shipmentXid: string
  The XID for the shipment.
• shippingAgentContactGid: string
  Indicate if this NFRC is created from the Assign Shipping Agent action on the job.
• siCutoffDate: siCutoffDate
  The shippers instruction cutoff date associated with the shipment.
• sightingDate: sightingDate
  The date and time when the shipment was last sighted at the sighting location.
• sightingLocation: sightingLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sightingLocationGid: string
  The location where the shipment was last sighted.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• solePackagedItem: solePackagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• solePackagedItemGid: string
  only one equipment and with only one item
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sourceLocation: sourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourceLocationGid: string
  The GID of the source location of the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sourceLocationOverrideGid: string
  The location identifier that will override the source location that is defined for the shipment.
• sourcePierLocation: sourcePierLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourcePierLocationGid: string
  The source operational location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• srcArbLevelOfServiceGid: string
  The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.
• startTime: startTime
  The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.
• tariffDate: tariffDate
  The tariff date, for informational purposes.
• tariffName: string
  The tariff name, for informational purposes.
• tariffNumber: string
  The tariff number, for informational purposes.
• tariffOrganizationName: string
  The tariff organization name, for informational purposes.
• tariffOrganizationNumber: string
  The tariff organization number, for informational purposes.
• termLocationText: string
  The term location text that is informational for the shipment.
• totalActualCost: totalActualCost
  The total actual cost of the shipment.
• totalApprovedCost: totalApprovedCost
  The total approved cost associated with the shipment after the approval step in the freight payment process.
• totalDeclaredValue: totalDeclaredValue
  The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.
• totalItemPackageCount: number (int32)
  The total item package count of the shipment.
• totalNetVolume: totalNetVolume
  The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.
• totalNetWeight: totalNetWeight
  The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.
• totalNumReferenceUnits: number (double)
  The total number of reference units of the shipment as defined by the equipment reference units.
• totalPackagingUnitCount: number (int32)
  The total packaging unit count of the shipment.
• totalShipUnitCount: number (int64)
  The total ship unit count of the shipment.
• totalTransCost: totalTransCost
  The total cost of the shipment. It represents the total transportation cost after applying the rebate.
• totalVolume: totalVolume
  The total volume of the shipment.
• totalWeight: totalWeight
  The total weight of the shipment.
• totalWeightedCost: totalWeightedCost
  The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.
• totMatchedInvoiceCost: totMatchedInvoiceCost
  The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.
• transportModeGid: string
  A unique identifier to define the transportation modes.
• unloadedDistance: unloadedDistance
  The total distance that the truck or the transportation mode will travel when empty.
• userDefined1IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined2IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined3IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined4IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• userDefined5IconGid: string
  The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.
• vesselGid: string
  The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.
• volumeUtilization: number (double)
  The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.
• voyageGid: string
  The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.
• waybillDate: waybillDate
  Waybill date represents contractual agreement of the carriage.
• weighCode: string
  The weigh code of the shipment that identifies the weight type.
• weightUtilization: number (double)
  The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.
• workAssignmentBulkPlanGid: string
  Work assignment bulk plan ID which is generated during work assignment bulk plan process.
• workAssignmentGid: string
  The ID of the Work Assignment of which the shipment is part of.

{
    "properties":{
        "shipmentGid":{
            "description":"The GID for the shipment.",
            "type":"string"
        },
        "shipmentXid":{
            "description":"The XID for the shipment.",
            "type":"string"
        },
        "shipmentName":{
            "description":"A descriptive name of the shipment.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"A unique identifier to define the transportation modes.",
            "type":"string"
        },
        "isTemplate":{
            "description":"Indicates whether a shipment is a template.",
            "type":"boolean"
        },
        "isPrimary":{
            "description":"Indicates if the shipment is the primary shipment related to an order (bookings) path.",
            "type":"boolean"
        },
        "isSpotCosted":{
            "description":"Y/N based on whether the shipment cost is a spot cost specified by the service provider during a spot bid/broadcast tender.",
            "type":"boolean"
        },
        "isCreditNote":{
            "description":"Y/N based on an associated credit note.",
            "type":"boolean"
        },
        "cmPrevDestLocationGid":{
            "description":"The destination location of the previous shipment in the continuous move tour. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cmPrevDestLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "cmNextSourceLocationGid":{
            "description":"The source location of the next shipment in the continuous move tour. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cmNextSourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "totalActualCost":{
            "description":"The total actual cost of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalTransCost":{
            "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "loadedDistance":{
            "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unloadedDistance":{
            "description":"The total distance that the truck or the transportation mode will travel when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID of the source location of the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destLocationGid":{
            "description":"The GID of the destination location of the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "startTime":{
            "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "freightTerms":{
            "description":"The freight terms for the shipment, such as prepaid or collect.",
            "type":"string"
        },
        "parentLegGid":{
            "description":"The parent leg associated with the itinerary that may have been used to plan the shipment.",
            "type":"string"
        },
        "voyageGid":{
            "description":"The voyage identifier associated with the shipment if this shipment is planned using a voyage that has been loaded into the voyage table.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The service provider identifier associated with the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "rateOfferingGid":{
            "description":"The rate offering (contract) identifier that is used by the service provider moving this shipment.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The detailed rate record (contract) identifier that is used by the service provider moving this shipment.",
            "type":"string"
        },
        "originalShipmentGid":{
            "description":"If the shipment represents a secondary charge, this points back to the \"parent\" shipment for which the secondary shipment is a \"child\".",
            "type":"string"
        },
        "isAutoMergeConsolidate":{
            "description":"Y/N indicating if the auto merge consolidation rule was used from the itinerary when creating this shipment. (View Only)",
            "type":"boolean"
        },
        "perspective":{
            "description":"The indicates if the shipment is a buy or sell perspective.",
            "type":"string"
        },
        "flightInstanceId":{
            "description":"The flight instance (date of flight) identifier associated with the shipment if this shipment is planned using a flight in the flight table.",
            "type":"number",
            "format":"int64"
        },
        "totalWeight":{
            "description":"The total weight of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"The total volume of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalShipUnitCount":{
            "description":"The total ship unit count of the shipment.",
            "type":"number",
            "format":"int64"
        },
        "totalPackagingUnitCount":{
            "description":"The total packaging unit count of the shipment.",
            "type":"number",
            "format":"int32"
        },
        "totalItemPackageCount":{
            "description":"The total item package count of the shipment.",
            "type":"number",
            "format":"int32"
        },
        "intermediaryCorporationGid":{
            "description":"The intermediary corporation identifier if this shipment is being managed by an additional party to the shipper and carrier relationship such as a 3PL corporation. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "intermediaryCorporation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/corporations"
                }
            ],
            "readOnly":true
        },
        "shipmentTypeGid":{
            "description":"The shipment type associated with the shipment. This is a system value such as transport, secondary charge shipment, or non-freight related.",
            "type":"string"
        },
        "routeCodeCombinationGid":{
            "description":"The route code combination identifier of the shipment used for specifying rail shipments.",
            "type":"string"
        },
        "railInterModalPlanGid":{
            "description":"The rail intermodal plan identifier of the shipment used for intermodal rail shipments.",
            "type":"string"
        },
        "customerRateCode":{
            "description":"The customer rate identifier associated with the shipment if this shipment is planned using a customer.",
            "type":"string"
        },
        "cofcTofc":{
            "description":"The trailer or flat car or the container on flat car code for rail shipments.",
            "type":"string"
        },
        "railReturnLocationGid":{
            "description":"The rail return location identifier of the rail shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "railReturnLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "railReturnRouteGid":{
            "description":"The rail return route identifier of the rail shipment.",
            "type":"string"
        },
        "rule11Indicator":{
            "description":"The rule 11 indicator of the shipment used for managing rail.",
            "type":"string"
        },
        "currentStopNum":{
            "description":"The stop number within the shipment. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.",
            "type":"number",
            "format":"int32"
        },
        "shipmentAsWork":{
            "description":"Indicates the shipment as work.",
            "type":"boolean"
        },
        "secondaryChargeRuleGid":{
            "description":"The secondary charge rule identifier that was used to generate the shipment if this is a secondary charge shipment.",
            "type":"string"
        },
        "checkTimeConstraint":{
            "description":"The indicator to check the time constraints associated with the shipment.",
            "type":"boolean"
        },
        "checkCostConstraint":{
            "description":"The indicator to check cost constraints associated with the shipment",
            "type":"boolean"
        },
        "checkCapacityConstraint":{
            "description":"The indicator to check the capacity constraints associated with the shipment.",
            "type":"boolean"
        },
        "cmName":{
            "description":"The shipment GID of the first shipment in the tour. If the continuous move tour is received as input, this is the supplied tour ID.",
            "type":"string"
        },
        "cmSequenceNum":{
            "description":"Indicates the shipment's sequence in the continuous move tour.",
            "type":"number",
            "format":"int32"
        },
        "cmCost":{
            "description":"The shipment cost when the shipment is part of a continuous move tour.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "cmEmptyDistance":{
            "description":"The empty leg distance between previous and this shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazmatModeGid":{
            "description":"The hazmat mode identifier that is associated with the shipment.",
            "type":"string"
        },
        "hazmatRegionGid":{
            "description":"The hazmat region identifier that is associated with the shipment.",
            "type":"string"
        },
        "weighCode":{
            "description":"The weigh code of the shipment that identifies the weight type.",
            "type":"string"
        },
        "rule7":{
            "description":"A Y/N indicator from the shipper to the carrier that the shipper is not liable for freight charges.",
            "type":"boolean"
        },
        "shipmentReleased":{
            "description":"A Y/N indicator used for rail shipments that indicate that the shipment is ready.",
            "type":"boolean"
        },
        "processingCodeGid":{
            "description":"The processing code GID.",
            "type":"string"
        },
        "airRailRouteCode":{
            "description":"A transportation mode code that is informational for the shipment.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method code identifier.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The Incoterm identifier associated with the shipment.",
            "type":"string"
        },
        "dimWeight":{
            "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "plannedCost":{
            "description":"The cost when the original shipment was created.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "termLocationText":{
            "description":"The term location text that is informational for the shipment.",
            "type":"string"
        },
        "tariffOrganizationNumber":{
            "description":"The tariff organization number, for informational purposes.",
            "type":"string"
        },
        "tariffOrganizationName":{
            "description":"The tariff organization name, for informational purposes.",
            "type":"string"
        },
        "tariffName":{
            "description":"The tariff name, for informational purposes.",
            "type":"string"
        },
        "tariffNumber":{
            "description":"The tariff number, for informational purposes.",
            "type":"string"
        },
        "tariffDate":{
            "description":"The tariff date, for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "isHazardous":{
            "description":"A Y/N indicator specifying that the shipment is identified as having hazardous material.",
            "type":"boolean"
        },
        "isTemperatureControl":{
            "description":"A Y/N indicator specifying that the shipment is identified as needing temperature control.",
            "type":"boolean"
        },
        "isCostFixed":{
            "description":"A Y/N indicator that identifies the shipment having fixed cost that will not be recalculated if the shipment is modified.",
            "type":"boolean"
        },
        "isServiceTimeFixed":{
            "description":"A Y/N indicator that identifies the shipment having fixed service time that will not be recalculated if the shipment is modified.",
            "type":"boolean"
        },
        "isRateGeoFixed":{
            "description":"A Y/N indicator that the rate detail (rate geo) has been fixed by the user and will not be reassigned if the shipment is modified.",
            "type":"boolean"
        },
        "isRateOfferingFixed":{
            "description":"A Y/N indicator that the rate offering has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isServprovFixed":{
            "description":"A Y/N indicator that the service provider has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isPreload":{
            "description":"A Y/N indicator specifying that the shipment is pre-load prior to carrier arriving for transport.",
            "type":"boolean"
        },
        "isFixedTenderContact":{
            "description":"A Y/N indicator that the tender contact individual has been fixed by the user and will not be reassigned.",
            "type":"boolean"
        },
        "isToBeHeld":{
            "description":"A Y/N indicator specifying that the shipment is to be held by the carrier.",
            "type":"boolean"
        },
        "isPreferredCarrier":{
            "description":"Indicates if the carrier selected for the shipment is preferred.",
            "type":"boolean"
        },
        "isEquipmentFixed":{
            "description":"Checks if a service provider can update the equipment number and equipment initials when accepting a tendered shipment.",
            "type":"boolean"
        },
        "isRecalcTotals":{
            "description":"Turns on/off totaling logic.",
            "type":"boolean"
        },
        "hasAppointments":{
            "description":"Indicates if any stops on the shipment have appointments.",
            "type":"boolean"
        },
        "contactGid":{
            "description":"The contact identifier linking in the contact table information to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "contact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "bulkPlanGid":{
            "description":"If the shipment was planned via the bulk plan process, then this is the global identifier for the bulk plan.",
            "type":"string"
        },
        "totalNumReferenceUnits":{
            "description":"The total number of reference units of the shipment as defined by the equipment reference units.",
            "type":"number",
            "format":"double"
        },
        "itineraryGid":{
            "description":"The itinerary identifier that was used to build the shipment if it was built with the planning logic. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "itinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "feasibilityCodeGid":{
            "description":"The feasibility code associated with the shipment can identify shipment infeasibilities.",
            "type":"string"
        },
        "numOrderReleases":{
            "description":"The number of order releases that are on this shipment.",
            "type":"number",
            "format":"int32"
        },
        "numStops":{
            "description":"The number of shipment stop records related to this shipment.",
            "type":"number",
            "format":"int32"
        },
        "totalNetWeight":{
            "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalNetVolume":{
            "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "earliestStartTime":{
            "description":"The earliest start time that will make this shipment feasible.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latestStartTime":{
            "description":"The latest start time that will make this shipment feasible.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lastEventGroupGid":{
            "description":"The last event group identifier specifies the event group code of the last tracking event that was received against the shipment.",
            "type":"string"
        },
        "repetitionScheduleGid":{
            "description":"The repetition schedule associated with the shipment if the shipment was built utilizing a repetition schedule.",
            "type":"string"
        },
        "inTrailerBuild":{
            "description":"Indicates that this shipment is in a trailer build shipment group.",
            "type":"boolean"
        },
        "firstEquipmentGroupGid":{
            "description":"A shipment can contain multiple equipment records. This value is associated to the first equipment group defined for the shipment.",
            "type":"string"
        },
        "bulkCmGid":{
            "description":"The identifier for the bulk continuous move if the shipment was selected in the bulk continuous move process.",
            "type":"string"
        },
        "vesselGid":{
            "description":"The vessel that the shipment is on. If populated, this actually overrides the value that is in the voyage table.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"The GID for the user defined image/icon. Up to five user-defined image fields can be configured to appear on the Search and Results page that let you query and review the images that are assigned to a business object. Images can be assigned to business objects to visually emphasize certain characteristics such as shipments containing hazardous material, orders for hot commodities, or shipments with over dimensional freight.",
            "type":"string"
        },
        "sourceLocationOverrideGid":{
            "description":"The location identifier that will override the source location that is defined for the shipment.",
            "type":"string"
        },
        "destLocationOverrideGid":{
            "description":"The location identifier that will override the destination location that is defined for the shipment.",
            "type":"string"
        },
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference unit GID that is associated with the equipment reference unit utilization of the shipment.",
            "type":"string"
        },
        "scheduleType":{
            "description":"When the schedule type is populated, it is a consol.",
            "type":"string"
        },
        "weightUtilization":{
            "description":"The weight utilization of the shipment as defined by the weight of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "volumeUtilization":{
            "description":"The volume utilization of the shipment as defined by the volume of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "equipRefUnitUtilization":{
            "description":"The equipment reference utilization of the shipment as defined by the equipment reference unit amount of the freight and the maximum capacity of the equipment.",
            "type":"number",
            "format":"double"
        },
        "jobGid":{
            "description":"The job GID identifier of the shipment, if the shipment is assigned to a job.",
            "type":"string"
        },
        "portOfLoadLocationGid":{
            "description":"The location ID of the port of load for the primary leg carrier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfLoadLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfLoadOverrideLocGid":{
            "description":"The location override ID of the port of load for the primary leg carrier.",
            "type":"string"
        },
        "portOfDisLocationGid":{
            "description":"The location ID of the port of discharge for the primary leg carrier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portOfDisLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "portOfDisOverrideLocGid":{
            "description":"The location override ID of the port of discharge for the primary leg carrier.",
            "type":"string"
        },
        "insurancePolicyNumber":{
            "description":"The insurance policy number that covers this shipment, for informational purposes.",
            "type":"string"
        },
        "insuranceAmount":{
            "description":"The insurance amount of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "insurancePremium":{
            "description":"The insurance premium of the shipment, for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "bolType":{
            "description":"The bill of lading type defined for the shipment, used for report management.",
            "type":"string"
        },
        "bolIssuanceType":{
            "description":"The bill of lading issuance type identifier.",
            "type":"string"
        },
        "consolGid":{
            "description":"The consol identifier if the shipment has been built from a consol structure. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "consol":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/consols"
                }
            ],
            "readOnly":true
        },
        "placeReceiptLocationGid":{
            "description":"The place receipt location identifier specifying the location where ownership of freight starts. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "placeReceiptLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "placeDeliverLocationGid":{
            "description":"The place deliver location identifier specifying the location where ownership of freight ends with delivery. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "placeDeliverLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sailDate":{
            "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "railDate":{
            "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sailCutoffDate":{
            "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portDischargeEta":{
            "description":"The estimated port of discharge date associated with ocean-going shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portOfExitDate":{
            "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "portExitLocGid":{
            "description":"The designated port the freight will be exiting the country for international shipments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "portExitLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "containerDeliveryLocGid":{
            "description":"The container delivery location identifier establishing where the ocean going container will be delivered after unloading freight. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "containerDeliveryLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "containerPickupLocGid":{
            "description":"The container pickup location identifier establishing where the ocean-going container will be picked up prior to loading with freight. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "containerPickupLoc":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "nfrcRuleGid":{
            "description":"The NFRC (non freight related charge) rule that was used to generate the shipment if the shipment is a NFRC type of shipment.",
            "type":"string"
        },
        "isCpctyOverrideApplicable":{
            "description":"A Y/N indicator specifying if the capacity override is applicable where capacity defines the resource a service provider has available for assignment.",
            "type":"boolean"
        },
        "plannedRateOfferingGid":{
            "description":"The initial planned rate offering ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "plannedTransportModeGid":{
            "description":"The initial planned transport mode ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "plannedServprovGid":{
            "description":"The initial planned service provider ID. It is set when shipment initially gets planned. It will not be changed thereafter. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "plannedServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "plannedRateGeoGid":{
            "description":"The initial planned rate record ID. It is set when shipment initially gets planned. It will not be changed thereafter.",
            "type":"string"
        },
        "isPermanent":{
            "description":"Set this flag to 'Y' if the shipment should not be automatically deleted as a result of unassign/merge/split action. In this case, the shipment should be specifically deleted in \"delete shipment\" action.",
            "type":"boolean"
        },
        "isMemoBl":{
            "description":"Indicate how to handle B/L. Y: no bill of lading generated for this shipment. N: bill of lading generated for this shipment.",
            "type":"boolean"
        },
        "dutyPaid":{
            "description":"The duty paid of the shipment.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "currencyGid":{
            "description":"Indicates the currency to be used for cost totals; if null, the first shipment cost of type base will dictate the currency.",
            "type":"string"
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "totMatchedInvoiceCost":{
            "description":"The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "originalInvoiceCost":{
            "description":"The original invoice cost at the point when the invoice was initially created or matched to the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalApprovedCost":{
            "description":"The total approved cost associated with the shipment after the approval step in the freight payment process.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "sourcePierLocationGid":{
            "description":"The source operational location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourcePierLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destPierLocationGid":{
            "description":"The destination operational location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destPierLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "primaryOrderBaseGid":{
            "description":"A shipment can contain multiple orders and these orders can refer to multiple order bases. The bill to party of an order base is carried forward to the shipment. This field reflects the order base identifier that was used to establish this value. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "primaryOrderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "totalDeclaredValue":{
            "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isProfitSplit":{
            "description":"Indicates if the NFRC shipment will be profit split.",
            "type":"boolean"
        },
        "shippingAgentContactGid":{
            "description":"Indicate if this NFRC is created from the Assign Shipping Agent action on the job.",
            "type":"string"
        },
        "isAdvancedCharge":{
            "description":"A Y/N indicator specifying that this NFRC shipment is built as an advanced charge.",
            "type":"boolean"
        },
        "loadConfigEngineTypeGid":{
            "description":"Null type means no load configuration is performed on the shipment.",
            "type":"string"
        },
        "appointmentPriorityGid":{
            "description":"The appointment priority identifier associated with the shipment.",
            "type":"string"
        },
        "isFixedDistance":{
            "description":"Boolean, defaults to N. When set to Y, this flag indicates a user-entered value for the total loaded distance field.",
            "type":"boolean"
        },
        "deliveringServprovGid":{
            "description":"The service provider who is the delivering service provider for this shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "deliveringServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "originatingServprovGid":{
            "description":"The service provider who is the originating service provider for this shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "originatingServprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "chargeableWeight":{
            "description":"The dimensional weight as determined by the rating process.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "fixedServiceDays":{
            "description":"The fixed number of service days, if returned by the rating engine.",
            "type":"number",
            "format":"int32"
        },
        "sightingLocationGid":{
            "description":"The location where the shipment was last sighted. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sightingDate":{
            "description":"The date and time when the shipment was last sighted at the sighting location.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "prevSightingLocationGid":{
            "description":"The location identifier for the previous sighting location used for rail shipment and tracking events. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "prevSightingLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevSightingDate":{
            "description":"The date associated with the previous sighting location and in the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "driverGid":{
            "description":"The driver or primary team driver assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "driver":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/drivers"
                }
            ],
            "readOnly":true
        },
        "secondaryDriverGid":{
            "description":"The secondary team driver assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "secondaryDriver":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/drivers"
                }
            ],
            "readOnly":true
        },
        "powerUnitGid":{
            "description":"The power unit assigned to the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "powerUnit":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/powerUnits"
                }
            ],
            "readOnly":true
        },
        "driverAssignBulkPlanGid":{
            "description":"Fleet bulk plan ID for driver assignment.",
            "type":"string"
        },
        "equipmentAssignBulkPlanGid":{
            "description":"Fleet bulk plan ID for equipment assignment.",
            "type":"string"
        },
        "prevDropInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for driver's previous shipment's equipment.",
            "type":"boolean"
        },
        "pickInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for picking an empty equipment before freight.",
            "type":"boolean"
        },
        "dropInventoryProcessed":{
            "description":"Indicates fleet equipment inventory processing for dropping an empty equipment after freight.",
            "type":"boolean"
        },
        "dimVolume":{
            "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "chargeableVolume":{
            "description":"The actual volume used in calculating the cost of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"The database domain where this data is stored.",
            "type":"string"
        },
        "planningParameterSetGid":{
            "description":"The parameter set GID which is used in building this shipment.",
            "type":"string"
        },
        "numEquipmentOrdered":{
            "description":"The number of equipment ordered. This is manually set by the user and can be rated on.",
            "type":"number",
            "format":"int32"
        },
        "emPhoneNumber":{
            "description":"The emergency phone number when shipping hazardous materials. The 24 hours contact for the shipment.",
            "type":"string"
        },
        "parcelZone":{
            "description":"The ship to mail zone. A price key used for parcel rate calculations.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"The attribute currency of the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "combinationEquipGrpGid":{
            "description":"The equipment group associated with the shipment if the shipment contains combination trailers or combination compartments. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "combinationEquipGrp":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "siCutoffDate":{
            "description":"The shippers instruction cutoff date associated with the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "cfsCutoffDate":{
            "description":"The container freight station cutoff date associated with the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "srcArbLevelOfServiceGid":{
            "description":"The source arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the source arbitrary part.",
            "type":"string"
        },
        "destArbLevelOfServiceGid":{
            "description":"The destination arbitrary level of service identifier if the shipment is built using a rate that has arbitrary values. In this case the shipment will identify the rate service used for the main leg and this will be the service of the destination arbitrary part.",
            "type":"string"
        },
        "cfsLocationGid":{
            "description":"The location identifier for the container freight station. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "cfsLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "isFixedVoyage":{
            "description":"A Y/N indicator specifying if the voyage part of the shipment is to remain fixed on updates.",
            "type":"boolean"
        },
        "workAssignmentBulkPlanGid":{
            "description":"Work assignment bulk plan ID which is generated during work assignment bulk plan process.",
            "type":"string"
        },
        "aheadLateTime":{
            "description":"shipment status",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "aheadOrLate":{
            "description":"A - Ahead of Schedule O - On Time L - Late T - Tardy - This can mean a degree of lateness depending on the user.  B - Bad Order H - Held N - No Bill Y - Constructive Placed Z - Actual Placed  ",
            "type":"string"
        },
        "etaDate":{
            "description":"Estimated time of arrival",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "firstEquipmentInitial":{
            "description":"first equipment intial",
            "type":"string"
        },
        "firstEquipmentNumber":{
            "description":"first equipment number",
            "type":"string"
        },
        "solePackagedItemGid":{
            "description":"only one equipment and with only one item \t <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "solePackagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "reportedBsStatusCode":{
            "description":"latest reported event for shipment",
            "type":"string"
        },
        "reportingScac":{
            "description":"reporting scac",
            "type":"string"
        },
        "equipmentDestination":{
            "description":"equipment destination <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentDestinationRefObject":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "prevReportedBsStatusCode":{
            "description":"previous reported event for shipment",
            "type":"string"
        },
        "prevReportingScac":{
            "description":"previous reporting scac",
            "type":"string"
        },
        "prevEquipmentDestination":{
            "description":"previous equipment destination <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "prevEquipmentDestinationRefObject":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "maxNumRetender":{
            "description":"Maximum number of re-tenders.",
            "type":"number",
            "format":"int32"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "reservationNum":{
            "description":"Saved here to search shipments based on Reservation Number.",
            "type":"string"
        },
        "isArRouteCodeFixed":{
            "description":"This flag is for rail route code on shipment to allow or restrict cost/rail route code updates.",
            "type":"boolean"
        },
        "waybillDate":{
            "description":"Waybill date represents contractual agreement of the carriage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "projectedTourName":{
            "description":"Represents the identifier for the projected tour. If the projected tour is received as input, this is the supplied tour ID.",
            "type":"string"
        },
        "projectedTourSequenceNum":{
            "description":"Represents the sequence in which the shipment should appear in the projected tour.",
            "type":"number",
            "format":"int32"
        },
        "externalVoyageCode":{
            "description":"Specifies the number of the voyage as assigned by the carrier that transports the shipment.",
            "type":"string"
        },
        "plannedCo2Emission":{
            "description":"CO2 emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2Emission":{
            "description":"Actual CO2 emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "plannedCo2EqEmission":{
            "description":"CO2 equivalent emissions recorded while planning the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualCo2EqEmission":{
            "description":"Actual CO2 equivalent emissions for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "marketCost":{
            "description":"Market cost based on the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "loadingHallPenalty":{
            "description":"The loading hall penalty used while building loading halls for the shipment.",
            "type":"number",
            "format":"double"
        },
        "workAssignmentGid":{
            "description":"The ID of the Work Assignment of which the shipment is part of.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCo2Emission

Actual CO2 emissions for the shipment.

Match All

Actual CO2 emissions for the shipment.

Show Source

• object amountType

{
    "description":"Actual CO2 emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualCo2EqEmission

Actual CO2 equivalent emissions for the shipment.

Match All

Actual CO2 equivalent emissions for the shipment.

Show Source

• object amountType

{
    "description":"Actual CO2 equivalent emissions for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : aheadLateTime

shipment status

Match All

shipment status

Show Source

• object amountType

{
    "description":"shipment status",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

The attribute currency of the shipment.

Match All

The attribute currency of the shipment.

Show Source

• object currencyType

{
    "description":"The attribute currency of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cfsCutoffDate

The container freight station cutoff date associated with the shipment.

Match All

The container freight station cutoff date associated with the shipment.

Show Source

• object dateTimeType

{
    "description":"The container freight station cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cfsLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cfsLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : chargeableVolume

The actual volume used in calculating the cost of the shipment.

Match All

The actual volume used in calculating the cost of the shipment.

Show Source

• object amountType

{
    "description":"The actual volume used in calculating the cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : chargeableWeight

The dimensional weight as determined by the rating process.

Match All

The dimensional weight as determined by the rating process.

Show Source

• object amountType

{
    "description":"The dimensional weight as determined by the rating process.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : cmCost

The shipment cost when the shipment is part of a continuous move tour.

Match All

The shipment cost when the shipment is part of a continuous move tour.

Show Source

• object currencyType

{
    "description":"The shipment cost when the shipment is part of a continuous move tour.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : cmEmptyDistance

The empty leg distance between previous and this shipments.

Match All

The empty leg distance between previous and this shipments.

Show Source

• object amountType

{
    "description":"The empty leg distance between previous and this shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : cmNextSourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmNextSourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : cmPrevDestLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property cmPrevDestLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : combinationEquipGrp

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property combinationEquipGrpGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : consol

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property consolGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/consols"
        }
    ],
    "readOnly":true
}

Nested Schema : contact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property contactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : containerDeliveryLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerDeliveryLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : containerPickupLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property containerPickupLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : deliveringServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property deliveringServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : destLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : destPierLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destPierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : dimVolume

The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.

Match All

The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.

Show Source

• object amountType

{
    "description":"The dimensional volume. Mathematical weight equivalence according to specified dim rate factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : dimWeight

The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.

Match All

The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.

Show Source

• object amountType

{
    "description":"The dimensional weight that was calculated for the shipment when using the dimensional rating (DIM) factor.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : driver

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object drivers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property driverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/drivers"
        }
    ],
    "readOnly":true
}

Nested Schema : earliestStartTime

The earliest start time that will make this shipment feasible.

Match All

The earliest start time that will make this shipment feasible.

Show Source

• object dateTimeType

{
    "description":"The earliest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : endTime

The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Match All

The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.

Show Source

• object dateTimeType

{
    "description":"The time the shipment is delivered. Initially this is the system expected delivery time. It is updated with the actual delivery time when the shipment is delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentDestinationRefObject

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : etaDate

Estimated time of arrival

Match All

Estimated time of arrival

Show Source

• object dateTimeType

{
    "description":"Estimated time of arrival",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insuranceAmount

The insurance amount of the shipment.

Match All

The insurance amount of the shipment.

Show Source

• object currencyType

{
    "description":"The insurance amount of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : insurancePremium

The insurance premium of the shipment, for informational purposes.

Match All

The insurance premium of the shipment, for informational purposes.

Show Source

• object currencyType

{
    "description":"The insurance premium of the shipment, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : intermediaryCorporation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property intermediaryCorporationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/corporations"
        }
    ],
    "readOnly":true
}

Nested Schema : itinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : latestStartTime

The latest start time that will make this shipment feasible.

Match All

The latest start time that will make this shipment feasible.

Show Source

• object dateTimeType

{
    "description":"The latest start time that will make this shipment feasible.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : loadedDistance

The total distance that the truck or the transportation mode will travel when the shipment is loaded.

Match All

The total distance that the truck or the transportation mode will travel when the shipment is loaded.

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when the shipment is loaded.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : marketCost

Market cost based on the shipment.

Match All

Market cost based on the shipment.

Show Source

• object currencyType

{
    "description":"Market cost based on the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : originalInvoiceCost

The original invoice cost at the point when the invoice was initially created or matched to the shipment.

Match All

The original invoice cost at the point when the invoice was initially created or matched to the shipment.

Show Source

• object currencyType

{
    "description":"The original invoice cost at the point when the invoice was initially created or matched to the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : originatingServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originatingServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : placeDeliverLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeDeliverLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : placeReceiptLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property placeReceiptLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : plannedCo2Emission

CO2 emissions recorded while planning the shipment.

Match All

CO2 emissions recorded while planning the shipment.

Show Source

• object amountType

{
    "description":"CO2 emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCo2EqEmission

CO2 equivalent emissions recorded while planning the shipment.

Match All

CO2 equivalent emissions recorded while planning the shipment.

Show Source

• object amountType

{
    "description":"CO2 equivalent emissions recorded while planning the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : plannedCost

The cost when the original shipment was created.

Match All

The cost when the original shipment was created.

Show Source

• object currencyType

{
    "description":"The cost when the original shipment was created.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : plannedServprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property plannedServprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : portDischargeEta

The estimated port of discharge date associated with ocean-going shipments.

Match All

The estimated port of discharge date associated with ocean-going shipments.

Show Source

• object dateTimeType

{
    "description":"The estimated port of discharge date associated with ocean-going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : portExitLoc

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portExitLocGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfDisLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfDisLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : portOfExitDate

The estimated port of exit (for international shipments) associated with ocean going shipments.

Match All

The estimated port of exit (for international shipments) associated with ocean going shipments.

Show Source

• object dateTimeType

{
    "description":"The estimated port of exit (for international shipments) associated with ocean going shipments.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : portOfLoadLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property portOfLoadLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : powerUnit

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property powerUnitGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/powerUnits"
        }
    ],
    "readOnly":true
}

Nested Schema : prevEquipmentDestinationRefObject

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevEquipmentDestination, which will be expanded if expandRefs query parameter is set to true (expandRefs=true) <br> This reference object will be displayed only when the optional feature: APPEND REFOBJECT FOR REF ATTR NOT ENDING WITH GID is enabled.",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : prevSightingDate

The date associated with the previous sighting location and in the tracking event.

Match All

The date associated with the previous sighting location and in the tracking event.

Show Source

• object dateTimeType

{
    "description":"The date associated with the previous sighting location and in the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : prevSightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property prevSightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : primaryOrderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property primaryOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : railDate

The rail date of the shipment that is populated if the shipment utilizes the rail schedules.

Match All

The rail date of the shipment that is populated if the shipment utilizes the rail schedules.

Show Source

• object dateTimeType

{
    "description":"The rail date of the shipment that is populated if the shipment utilizes the rail schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : railReturnLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property railReturnLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : sailCutoffDate

The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.

Match All

The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.

Show Source

• object dateTimeType

{
    "description":"The sail cutoff (date of sail) identifier associated with the shipment if this shipment is planned using a sail on the sail table.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sailDate

The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.

Match All

The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.

Show Source

• object dateTimeType

{
    "description":"The sail date of the shipment that is populated if the shipment utilizes the vessel schedules.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : secondaryDriver

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object drivers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property secondaryDriverGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/drivers"
        }
    ],
    "readOnly":true
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : siCutoffDate

The shippers instruction cutoff date associated with the shipment.

Match All

The shippers instruction cutoff date associated with the shipment.

Show Source

• object dateTimeType

{
    "description":"The shippers instruction cutoff date associated with the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingDate

The date and time when the shipment was last sighted at the sighting location.

Match All

The date and time when the shipment was last sighted at the sighting location.

Show Source

• object dateTimeType

{
    "description":"The date and time when the shipment was last sighted at the sighting location.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sightingLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sightingLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : solePackagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property solePackagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : sourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : sourcePierLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourcePierLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : startTime

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Match All

The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.

Show Source

• object dateTimeType

{
    "description":"The actual shipment start time. Initially it is the system expected start time. It is updated once the carrier actually starts the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : tariffDate

The tariff date, for informational purposes.

Match All

The tariff date, for informational purposes.

Show Source

• object dateType

{
    "description":"The tariff date, for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : totalActualCost

The total actual cost of the shipment.

Match All

The total actual cost of the shipment.

Show Source

• object currencyType

{
    "description":"The total actual cost of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalApprovedCost

The total approved cost associated with the shipment after the approval step in the freight payment process.

Match All

The total approved cost associated with the shipment after the approval step in the freight payment process.

Show Source

• object currencyType

{
    "description":"The total approved cost associated with the shipment after the approval step in the freight payment process.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalDeclaredValue

The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.

Match All

The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.

Show Source

• object currencyType

{
    "description":"The total declared value of the goods on the shipment. This is the sum of the declared values of the shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalNetVolume

The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.

Match All

The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.

Show Source

• object amountType

{
    "description":"The total net volume of all the freight on the shipment as summed with the shipment ship unit lines net volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalNetWeight

The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.

Match All

The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.

Show Source

• object amountType

{
    "description":"The total net weight of all the freight on the shipment as summed with the shipment ship unit lines net weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalTransCost

The total cost of the shipment. It represents the total transportation cost after applying the rebate.

Match All

The total cost of the shipment. It represents the total transportation cost after applying the rebate.

Show Source

• object currencyType

{
    "description":"The total cost of the shipment. It represents the total transportation cost after applying the rebate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalVolume

The total volume of the shipment.

Match All

The total volume of the shipment.

Show Source

• object amountType

{
    "description":"The total volume of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

The total weight of the shipment.

Match All

The total weight of the shipment.

Show Source

• object amountType

{
    "description":"The total weight of the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeightedCost

The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.

Match All

The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.

Show Source

• object currencyType

{
    "description":"The total weighted cost of the shipment considering any additional preference weighting to influence selection positive or negative.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totMatchedInvoiceCost

The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.

Match All

The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.

Show Source

• object currencyType

{
    "description":"The total matched invoice cost associated with the shipment after the match and pay process runs in freight payment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : unloadedDistance

The total distance that the truck or the transportation mode will travel when empty.

Match All

The total distance that the truck or the transportation mode will travel when empty.

Show Source

• object amountType

{
    "description":"The total distance that the truck or the transportation mode will travel when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : waybillDate

Waybill date represents contractual agreement of the carriage.

Match All

Waybill date represents contractual agreement of the carriage.

Show Source

• object dateTimeType

{
    "description":"Waybill date represents contractual agreement of the carriage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.shipmentDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type String.
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number.
• domainName: string
  No description.
• links: array links
  Read Only: true
• remarks: remarks
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  The GID of shipment in the shipment group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "shipmentGid":{
            "description":"The GID of shipment in the shipment group.  <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type String. ",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Number. ",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentGroups.shipmentDetails.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date.

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentGroups.shipmentDetails.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.shipmentDetails.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier, or remark type.
• remarkSequence: number (int64)
  The one-up number to make the remark record unique.
• remarkText: string
  User entered remark on the shipment group detail

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark record unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"User entered remark on the shipment group detail",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentGroups.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type of the shipment group
• statusValueGid: string
  The status value for the status type of the shipment group

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type of the shipment group ",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the status type of  the shipment group ",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.allocations.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release record.
• invoiceGid: string
  Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill
• lineitemSeqNo: number (int32)
  Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill
• links: array links
  Read Only: true
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based on shipment
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release record.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "lineitemSeqNo":{
            "description":"Voucher/Bill line item seq no would be stored if we perform allocation based on voucher or bill",
            "type":"number",
            "format":"int32"
        },
        "invoiceGid":{
            "description":"Invoice/Bill Gid would be stored in this field if allocation is done based on Invoice or Bill",
            "type":"string"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based on  shipment ",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderReleases.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderReleases.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.equipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipment: equipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGid: string
  The actual equipment GID if the equipment is managed in the database.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  The seal sequence to allow for multiple seals to be defined.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentInitial: string
  The equipment initial as an identifier specified for this order release equipment.
• equipmentInitialNumber: string
  The equipment initial and number as an identifier specified for this order release equipment.
• equipmentNumber: string
  The equipment number as an identifier specified for this order release equipment.
• equipmentType: equipmentType
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentTypeGid: string
  The equipment seal number for the order release ordered equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• orEquipmentSeq: number (int32)
  The equipment sequence to allow for multiple equipment request to be specified on the order release.
• seals: seals

{
    "properties":{
        "orEquipmentSeq":{
            "description":"The equipment sequence to allow for multiple equipment request to be specified on the order release.",
            "type":"number",
            "format":"int32"
        },
        "equipmentGroupGid":{
            "description":"The seal sequence to allow for multiple seals to be defined. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "equipmentTypeGid":{
            "description":"The equipment seal number for the order release ordered equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentType":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentTypes"
                }
            ],
            "readOnly":true
        },
        "equipmentNumber":{
            "description":"The equipment number as an identifier specified for this order release equipment.",
            "type":"string"
        },
        "equipmentInitial":{
            "description":"The equipment initial as an identifier specified for this order release equipment.",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"The equipment initial and number as an identifier specified for this order release equipment.",
            "type":"string"
        },
        "equipmentGid":{
            "description":"The actual equipment GID if the equipment is managed in the database. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipments"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.equipments.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipments"
        }
    ],
    "readOnly":true
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : equipmentType

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object equipmentTypes

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentTypeGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentTypes"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.equipments.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.equipments.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• sealNumber: string
  The equipment seal number for the order release ordered equipment.
• sealSequence: number (int32)
  The seal sequence to allow for multiple seals to be defined.

{
    "properties":{
        "sealSequence":{
            "description":"The seal sequence to allow for multiple seals to be defined.",
            "type":"number",
            "format":"int32"
        },
        "sealNumber":{
            "description":"The equipment seal number for the order release ordered equipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The communication method for the involved party listed on the order release.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The involved party contact for the qualifier listed on the order release.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The involved party qualifier identifier.
• links: array links
  Read Only: true
• overrideAddresses: overrideAddresses
• overrideCity: string
  The location city that is to be used for this involved party on an order release in place of (overridden) the one on the location table.
• overrideCountryCode3Gid: string
  The location country code that is to be used for this involved party on an order release in place of (overridden) the one on the location table.
• overrideLocationName: string
  The location name that is to be used for this involved party on an order release in place of (overridden) the one on the location table.
• overridePostalCode: string
  The location postal code that is to be used for this involved party on an order release in place of (overridden) the one on the location table
• overrideProvince: string
  The location providence that is to be used for this involved party on an order release in place of (overridden) the one on the location table.
• overrideProvinceCode: string
  The location providence code that is to be used for this involved party on an order release in place of (overridden) the one on the location table.

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The involved party qualifier identifier.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The involved party contact for the qualifier listed on the order release. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method for the involved party listed on the order release.",
            "type":"string"
        },
        "overrideLocationName":{
            "description":"The location name that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideCity":{
            "description":"The location city that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideProvince":{
            "description":"The location providence that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideProvinceCode":{
            "description":"The location providence code that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overrideCountryCode3Gid":{
            "description":"The location country code that is to be used for this involved party on an order release in place of (overridden) the one on the location table.",
            "type":"string"
        },
        "overridePostalCode":{
            "description":"The location postal code that is to be used for this involved party on an order release in place of (overridden) the one on the location table",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "overrideAddresses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.involvedParties.overrideAddresses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : overrideAddresses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.involvedParties.overrideAddresses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.involvedParties.overrideAddresses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• lineSequence: number (int64)
  The line sequence (key) for the involved party on the order release.
• links: array links
  Read Only: true
• overrideAddressLine: string
  The address line that is to be used for this involved party on an order release in place (Overridden) of the one on the contact table for the involved party.

{
    "properties":{
        "lineSequence":{
            "description":"The line sequence (key) for the involved party on the order release.",
            "type":"number",
            "format":"int64"
        },
        "overrideAddressLine":{
            "description":"The address line that is to be used for this involved party on an order release in place (Overridden) of the one on the contact table for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.legConstraints"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• buyRateGeoGid: string
  The buy rate detail GID used as a planning constraint.
• buyRateOfferingGid: string
  The buy rate offering GID used as a planning constraint.
• domainName: string
  Database domain where this data is stored.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupGid: string
  The equipment group GID used as a planning constraint.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• equipmentGroupProfileGid: string
  The equipment group profile GID used as a planning constraint.
• legClassificationGid: string
  The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.
• legConsolidationGroupGid: string
  The load consolidation group set through network planning while managing leg classifications.
• links: array links
  Read Only: true
• modeProfileGid: string
  The mode profile GID used as a planning constraint.
• rateServiceProfileGid: string
  The rate service profile GID used as a planning constraint.
• sellRateGeoGid: string
  The sell rate detail GID used as a planning constraint.
• sellRateOfferingGid: string
  The sell rate offering GID used as a planning constraint.
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The service provider GID used as a planning constraint.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprovProfileGid: string
  The service provider profile GID used as a planning constraint.
• shipWithGroup: string
  The ship with group for applied to this leg classification.
• transportModeGid: string
  The transport mode GID used as a planning constraint.

{
    "properties":{
        "legClassificationGid":{
            "description":"The leg classification identifier. The leg classification on the order matches to a leg classification on the itinerary leg. The constraints defined here apply to that leg's shipment.",
            "type":"string"
        },
        "buyRateOfferingGid":{
            "description":"The buy rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateOfferingGid":{
            "description":"The sell rate offering GID used as a planning constraint.",
            "type":"string"
        },
        "buyRateGeoGid":{
            "description":"The buy rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "sellRateGeoGid":{
            "description":"The sell rate detail GID used as a planning constraint.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"The equipment group GID used as a planning constraint. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "equipmentGroupProfileGid":{
            "description":"The equipment group profile GID used as a planning constraint.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The transport mode GID used as a planning constraint.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"The mode profile GID used as a planning constraint.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The service provider GID used as a planning constraint. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "servprovProfileGid":{
            "description":"The service provider profile GID used as a planning constraint.",
            "type":"string"
        },
        "rateServiceProfileGid":{
            "description":"The rate service profile GID used as a planning constraint.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "shipWithGroup":{
            "description":"The ship with group for applied to this leg classification.",
            "type":"string"
        },
        "legConsolidationGroupGid":{
            "description":"The load consolidation group set through network planning while managing leg classifications.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorials: accessorials
• allocations: allocations
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributes: attributes
• billedQuantity: number (double)
  The billed quantity for order release line goods.
• billedQuantityUomCode: string
  The billed quantity unit of measure.
• billedQuantityUomType: string
  The billed quantity unit of measure type.
• brandName: string
  The brand name. For informational purposes.
• buyGeneralLedgerGid: string
  The general ledger code for the order release line for the buy side (cost).
• commercialInvoiceDescription: string
  A description field for the commercial invoice.
• commercialInvoiceGid: string
  The commercial invoice GID for the object that is associated with this order release line.
• declaredValue: declaredValue
  The declared cost of the item.
• domainName: string
  Database domain where this data is stored.
• equipmentRefUnits: equipmentRefUnits
• freeAlongSide: freeAlongSide
  Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.
• hazActivity: string
  The hazardous activity field indicates the level of radioactivity of the product.
• hazAllPacked: boolean
  Flag to indicate the package is "All packed in one".
• hazApprovalExemptionGid: string
  The hazardous approval exemption GID.
• hazardousClassificationGid: string
  The hazardous classification GID.
• hazAuthorization: string
  The authorization for the dangerous goods shipment. The authorization field is only required to state special governmental authorizations that are required because of the provisions or packing materials shipped with.
• hazChemicalFormula: string
  The basic chemical description of the substance.
• hazCompatibilityGroup: string
  The hazardous material compatibility group associated to the order release line.
• hazConcentrationPercent: number (double)
  Required if the dangerous goods UN number is 2031, 1796, 1826, or 1873. Enter the percentage of dangerous goods concentration if the above condition applies.
• hazControlTemp: hazControlTemp
  The hazardous control temperature to report for this order release line.
• hazCritSafetyIndex: number (double)
  A measurement for packages containing fissile material that is determined by dividing the number 50 by the smaller of the numbers determined using the rules in section 10.6.2.4.3 of the IATA Dangerous Goods Regulation Guide.
• hazEmergencyResponseInfo: string
  The emergency response information is a number associated with the International Maritime Organization (IMO), which promulgates, encourages, and enforces the highest standards of marine safety in vessel transport. Enter an IMDG emergency response number for this hazardous material.
• hazEmergencyTemp: hazEmergencyTemp
  The emergency temperature at which the product will begin the process of self-destructing or breaking down.
• hazEms: string
  The EMS (Emergency aboard Ship) field. The page number is required for documentation.
• hazErg: string
  The ERG (Emergency Response Guide) field. The page number is required for documentation purposes.
• hazErgAir: string
  The ERG (Emergency Response Guide) field for air. The page number is required for documentation purposes.
• hazExtCode: string
  The item hazmat code as configured in the TNT EM. (For carrier TNT).
• hazFlashPoint: hazFlashPoint
  The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.
• hazHazardousDescription: string
  A hazardous description for documentation.
• hazHazmatGenericGid: string
  The hazmat generic GID is the link between a hazardous material and a hazardous item.
• hazHazmatItemGid: string
  The hazmat item GID defines the entry in the hazmat table that contains attributes associated to this order release line.
• hazIdentificationNumber: string
  The hazardous classification ID is the numeric class of the hazardous material as specified by Department of Transportation regulations. Enter the hazard class in this field.
• hazIdgAddDescInfo: string
  The hazmat IDG additional description information.
• hazInhalationHazardZone: string
  This zone indicates the area of a toxicity hazard based on the concentration of the hazardous material.
• hazIsCommercialAircraftFor: boolean
  A Y/N indicator specifying the commercial aircraft forbidden indicator if the material cannot be transported on passenger aircraft.
• hazIsLimitedQuantity: boolean
  A Y/N indicator for the limited quantity residual amounts.
• hazIsMarinePollutant: boolean
  A Y/N indicator defining this order as a marine pollutant.
• hazIsNos: boolean
  A Y/N indicator defining this order release line as a hazardous not otherwise specified.
• hazIsOilContained: boolean
  A Y/N indicator that the check hazardous is oil contained field if the material is an oil-based product.
• hazIsOverpack: boolean
  Flag to indicate the package is an "overpack".
• hazIsPassengerAircraftForb: boolean
  A Y/N indicator specifying the passenger aircraft forbidden indicator if the material cannot be transported on passenger aircraft.
• hazIsReportableQuantity: boolean
  A Y/N indicator, the reportable quantity (RQ) indicator if the material is composed of quantities of other chemicals that are hazardous and must be reported by concentration percentage. RQs are the chemical components of a hazardous item that have reached a threshold in a shipping container that make them reportable as hazardous items.
• hazIsToxicInhalation: boolean
  A Y/N indicator defining the hazardous toxic inhalation value.
• hazMaxQuantity: number (double)
  The maximum passenger volume or the maximum cargo volume for the item. Used in Q- Value calculation.
• hazMpTechnicalName: string
  The marine pollutant technical name for this hazardous substance.
• hazMpTechnicalName2: string
  The marine pollutant technical name for this hazardous substance. You can specify up to 2.
• hazNetExplosvContentWeight: hazNetExplosvContentWeight
  The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.
• hazNosTechnicalName: string
  The Not Otherwise Specified (NOS) indicator if the material is composed of other chemicals not specified add the technical name.
• hazNosTechnicalName2: string
  The not otherwise specified (NOS) field if the material is composed of other chemicals not specified add the technical name. You can specify up to 2.
• hazOuterPackagingType: string
  Outer packaging type if packing type = All packed in one.
• hazOuterPackingCount: number (double)
  The outer packing count.
• hazPackageType: string
  The hazmat package type of the dangerous goods shipment.
• hazPackagingGroup: string
  The packaging group denotes the classification of hazardous packaging for this material based on the reportable quantity of the material.
• hazPackingCount: number (double)
  The packing count (number of packaged units).
• hazPackingInstructions: string
  Required for dangerous goods shipments, unless the dangerous goods class is radioactive or not restricted. See Table 4.2 columns G, I, or K of the IATA Dangerous Goods Regulation Guide.
• hazPhysicalForm: string
  A description of the physical form of the radioactive substance: S(p)ecial, (S)olid, (L)iquid, (G)as.
• hazProperShippingName: string
  The hazardous proper shipping name for the hazardous material is similar, but not identical to, the hazardous technical name of the material.
• hazPsaSingaporeGroup: string
  For the hazardous PSA Singapore Group enter a I, II, OR III. This regulates the cost of hazardous charge/cost at the Singapore destination.
• hazQuantity: number (double)
  The hazmat item quantity.
• hazQValue: number (double)
  The ratio used to indicate that the combined quantities in "all packed in one" package are within the maximum allowable limits.
• hazRadioactiveLabel: string
  The type of label on the shipment. W1 (White I), Y2 (Yellow II), Y3 (Yellow III).
• hazRadioactivity: number (double)
  A measurement of the activity of the shipment. For fissile material, the weight of the material in grams or kilograms may be substituted for the activity measurement.
• hazRadioactivityUnits: string
  The units that the activity were measured in. This must be in Becquerel units (or multiples thereof): Bq (Becquerel), kBq (kilobecquerel), MBq (megabecquerel), GBq (gigabecquerel), TBq (terabecquerel), PBq (petabecquerel).
• hazRadionuclide: string
  The radionuclide assigned to the substance being shipped. A table of basic radionuclides is available in the IATA Dangerous Goods Regulation Guide section 10.4.A. For example, aluminum (13) has a radionuclide Al-26.
• hazRadPackaging: string
  A description of the type of packaging the substance is contained in. Acceptable package types are listed in section 10.5 of the dangerous goods regulations guide: Expected (Expected), Industrial ip1 (Industrial Type 1(IP-1)), Industrial ip2 (Industrial Type 2(IP-2)), Industrial ip3 (Industrial Type 3(IP-3)), Type a (Type A), Type b(m) ( Type B(M)), Type b(u) ( Type B(U)), Type c ( Type C ).
• hazRqTechnicalName: string
  The reportable quantity technical name.
• hazRqTechnicalName2: string
  The reportable quantity technical name. You can specify up to 2.
• hazSpecialProvisions: string
  Indicates dangerous goods (DG) are being shipped under one of the special provisions listed in the IATA Dangerous Goods Regulation Guide, section 4.4. There appear to be 146 different provisions, and multiple provisions may apply to a single item in some cases.
• hazSubsidiaryHazard: string
  The subsidiary hazard represents a Department of Transportation-specified code pertaining to the cleanup of a spill of a hazardous material.
• hazSubstanceNumber: string
  The hazardous materials substance number.
• hazSurfaceReading: number (double)
  The surface reading of the radiation exposure for the package. This reading must be measured in mrem/h.
• hazTransportIndex: number (double)
  A number based on the radiation exposure of a package. This is determined based on the maximum measurement of the radiation in mrem/h at a distance of 1 meter from the package surface.
• hazType: string
  The hazardous materials type. Valid values are: l = Limited Quantities, e = 500 KG Exemption, f = Fully Regulated (Purolater).
• hazUnits: string
  IATA units for non UPS shipments (L=>Liters g=>Grams kg=>Kilograms kg G=>Kilograms Gross).
• initialItem: initialItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• initialItemGid: string
  Can be used to define the substitution.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedParties: involvedParties
• isDrawback: boolean
  A Y/N indicator defining if this order release line is part of the duty drawback program.
• isHazardous: boolean
  A Y/N indicator defining if the order release line is a hazardous goods. This is a transactional setting instead of looking at the item master definitions.
• isSplitAllowed: boolean
  Indicates if the order release ship units that are created can be split into multiple pieces of equipment.
• itemPackageCount: number (int64)
  The packaging unit count associated to the packaging unit for this order release line.
• links: array links
  Read Only: true
• loadConfigSetupGid: string
  A load configuration set up identifier to be used by the load configuration engine as the input rules during ship unit building.
• manufacturedCountryCodeGid: string
  The country code GID where this order release line was manufactured.
• numLayersPerShipUnit: number (int64)
  The number of layers for the transportation handling unit defined here on the order base line. This allows the user to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.
• obLineGid: string
  Read Only: true

  The order base line from which this order release line was built.
• obLineRelInstrSeq: number (int64)
  The order base line release instruction sequence number, carried over from column OB_RELEASE_INSTRUCTION_SEQ in table OB_RELEASE_INSTRUCTION when the order release line is created from an order base line.
• orderBase: orderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderBaseGid: string
  The order base from which this order release line was built.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• orderReleaseLineGid: string
  The GID for the order base line.
• orderReleaseLineXid: string
  The XID for the order base line.
• packageCoreDiameter: packageCoreDiameter
  The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.
• packageDiameter: packageDiameter
  The package diameter for order release line; overrides diameter on packaged item.
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item GID defining the item associated to this order release line.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packageHeight: packageHeight
  The package height for order release line; overrides height on packaged item.
• packageLength: packageLength
  The package length for order release line; overrides length on packaged item.
• packageWidth: packageWidth
  The package width for order release line; overrides width on packaged item.
• packagingUnitCount: number (int64)
  The packaging unit count associated to the packaging unit for this order base line.
• packagingUnitGid: string
  The packaging unit (considered an inner pack to the packaged item level) for this order release line.
• packWithGroup: string
  Lines with different Pack with Groups cannot be packed into the same ship unit.
• pricePerUnit: pricePerUnit
  The price per unit for the order release line to indicate the amount billed.
• pricePerUnitUomCode: string
  The unit of measurement this unit price is based on.
• pruDetails: pruDetails
• quantityPerLayer: number (int64)
  The quantity per layer for the transportation handling unit defined here on the order base line. This allows the user to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.
• refnums: refnums
• remarks: remarks
• secondaryVolume: secondaryVolume
  The order release line can be specified in a secondary volume value for informational purposes.
• secondaryWeight: secondaryWeight
  The order release line can be specified in a secondary weight value for informational purposes.
• sellGeneralLedgerGid: string
  The general ledger code for the order release line for the sell side (revenue).
• specialServices: specialServices
• tag1: string
  Additional information about the item. Like the color, size, or code.
• tag2: string
  Additional information about the item. Like the color, size, or code.
• tag3: string
  Additional information about the item. Like the color, size, or code.
• tag4: string
  Additional information about the item. Like the color, size, or code.
• texts: texts
• thuProfileGid: string
  The transport handling unit profile (list of valid THUs for this order line) that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged item table.
• totalBilledAmt: totalBilledAmt
  The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.
• transportHandlingUnitGid: string
  The transport handling unit that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged item table.
• volume: volume
  The volume of the item.
• weight: weight
  The weight of the item.

{
    "properties":{
        "orderReleaseLineGid":{
            "description":"The GID for the order base line.",
            "type":"string"
        },
        "orderReleaseLineXid":{
            "description":"The XID for the order base line.",
            "type":"string"
        },
        "weight":{
            "description":"The weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tag1":{
            "description":"Additional information about the item. Like the color, size, or code.",
            "type":"string"
        },
        "tag2":{
            "description":"Additional information about the item. Like the color, size, or code.",
            "type":"string"
        },
        "tag3":{
            "description":"Additional information about the item. Like the color, size, or code.",
            "type":"string"
        },
        "tag4":{
            "description":"Additional information about the item. Like the color, size, or code.",
            "type":"string"
        },
        "declaredValue":{
            "description":"The declared cost of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "initialItemGid":{
            "description":"Can be used to define the substitution. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "initialItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "packagingUnitGid":{
            "description":"The packaging unit (considered an inner pack to the packaged item level) for this order release line.",
            "type":"string"
        },
        "itemPackageCount":{
            "description":"The packaging unit count associated to the packaging unit for this order release line.",
            "type":"number",
            "format":"int64"
        },
        "packagedItemGid":{
            "description":"The packaged item GID defining the item associated to this order release line. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "buyGeneralLedgerGid":{
            "description":"The general ledger code for the order release line for the buy side (cost).",
            "type":"string"
        },
        "sellGeneralLedgerGid":{
            "description":"The general ledger code for the order release line for the sell side (revenue).",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count associated to the packaging unit for this order base line.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged item table.",
            "type":"string"
        },
        "numLayersPerShipUnit":{
            "description":"The number of layers for the transportation handling unit defined here on the order base line. This allows the user to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.",
            "type":"number",
            "format":"int64"
        },
        "quantityPerLayer":{
            "description":"The quantity per layer for the transportation handling unit defined here on the order base line. This allows the user to define the TiHi date used to build ship units on the order release per each transactional line passed in, instead of looking to the static TiHi data on the packaged item table.",
            "type":"number",
            "format":"int64"
        },
        "freeAlongSide":{
            "description":"Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isHazardous":{
            "description":"A Y/N indicator defining if the order release line is a hazardous goods. This is a transactional setting instead of looking at the item master definitions.",
            "type":"boolean"
        },
        "commercialInvoiceGid":{
            "description":"The commercial invoice GID for the object that is associated with this order release line.",
            "type":"string"
        },
        "commercialInvoiceDescription":{
            "description":"A description field for the commercial invoice.",
            "type":"string"
        },
        "secondaryWeight":{
            "description":"The order release line can be specified in a secondary weight value for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondaryVolume":{
            "description":"The order release line can be specified in a secondary volume value for informational purposes.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazHazmatGenericGid":{
            "description":"The hazmat generic GID is the link between a hazardous material and a hazardous item.",
            "type":"string"
        },
        "hazHazmatItemGid":{
            "description":"The hazmat item GID defines the entry in the hazmat table that contains attributes associated to this order release line.",
            "type":"string"
        },
        "hazIdentificationNumber":{
            "description":"The hazardous classification ID is the numeric class of the hazardous material as specified by Department of Transportation regulations. Enter the hazard class in this field.",
            "type":"string"
        },
        "hazProperShippingName":{
            "description":"The hazardous proper shipping name for the hazardous material is similar, but not identical to, the hazardous technical name of the material.",
            "type":"string"
        },
        "hazPackagingGroup":{
            "description":"The packaging group denotes the classification of hazardous packaging for this material based on the reportable quantity of the material.",
            "type":"string"
        },
        "hazFlashPoint":{
            "description":"The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazEmergencyTemp":{
            "description":"The emergency temperature at which the product will begin the process of self-destructing or breaking down.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazControlTemp":{
            "description":"The hazardous control temperature to report for this order release line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazSubsidiaryHazard":{
            "description":"The subsidiary hazard represents a Department of Transportation-specified code pertaining to the cleanup of a spill of a hazardous material. ",
            "type":"string"
        },
        "hazInhalationHazardZone":{
            "description":"This zone indicates the area of a toxicity hazard based on the concentration of the hazardous material.",
            "type":"string"
        },
        "hazEmergencyResponseInfo":{
            "description":"The emergency response information is a number associated with the International Maritime Organization (IMO), which promulgates, encourages, and enforces the highest standards of marine safety in vessel transport. Enter an IMDG emergency response number for this hazardous material.",
            "type":"string"
        },
        "hazNosTechnicalName":{
            "description":" The Not Otherwise Specified (NOS) indicator if the material is composed of other chemicals not specified add the technical name.",
            "type":"string"
        },
        "hazNetExplosvContentWeight":{
            "description":"The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "hazMpTechnicalName":{
            "description":"The marine pollutant technical name for this hazardous substance.",
            "type":"string"
        },
        "hazIsLimitedQuantity":{
            "description":"A Y/N indicator for the limited quantity residual amounts.",
            "type":"boolean"
        },
        "hazPsaSingaporeGroup":{
            "description":"For the hazardous PSA Singapore Group enter a I, II, OR III. This regulates the cost of hazardous charge/cost at the Singapore destination.",
            "type":"string"
        },
        "hazHazardousDescription":{
            "description":"A hazardous description for documentation.",
            "type":"string"
        },
        "hazIsReportableQuantity":{
            "description":"A Y/N indicator, the reportable quantity (RQ) indicator if the material is composed of quantities of other chemicals that are hazardous and must be reported by concentration percentage. RQs are the chemical components of a hazardous item that have reached a threshold in a shipping container that make them reportable as hazardous items.",
            "type":"boolean"
        },
        "hazRqTechnicalName":{
            "description":"The reportable quantity technical name.",
            "type":"string"
        },
        "hazActivity":{
            "description":"The hazardous activity field indicates the level of radioactivity of the product.",
            "type":"string"
        },
        "hazIsToxicInhalation":{
            "description":"A Y/N indicator defining the hazardous toxic inhalation value.",
            "type":"boolean"
        },
        "hazIsPassengerAircraftForb":{
            "description":"A Y/N indicator specifying the passenger aircraft forbidden indicator if the material cannot be transported on passenger aircraft.",
            "type":"boolean"
        },
        "hazIsCommercialAircraftFor":{
            "description":"A Y/N indicator specifying the commercial aircraft forbidden indicator if the material cannot be transported on passenger aircraft.",
            "type":"boolean"
        },
        "hazIsOilContained":{
            "description":"A Y/N indicator that the check hazardous is oil contained field if the material is an oil-based product.",
            "type":"boolean"
        },
        "hazNosTechnicalName2":{
            "description":"The not otherwise specified (NOS) field if the material is composed of other chemicals not specified add the technical name. You can specify up to 2.",
            "type":"string"
        },
        "hazRqTechnicalName2":{
            "description":"The reportable quantity technical name. You can specify up to 2.",
            "type":"string"
        },
        "hazMpTechnicalName2":{
            "description":"The marine pollutant technical name for this hazardous substance. You can specify up to 2.",
            "type":"string"
        },
        "hazardousClassificationGid":{
            "description":"The hazardous classification GID.",
            "type":"string"
        },
        "manufacturedCountryCodeGid":{
            "description":"The country code GID where this order release line was manufactured.",
            "type":"string"
        },
        "isDrawback":{
            "description":"A Y/N indicator defining if this order release line is part of the duty drawback program.",
            "type":"boolean"
        },
        "billedQuantity":{
            "description":"The billed quantity for order release line goods.",
            "type":"number",
            "format":"double"
        },
        "billedQuantityUomCode":{
            "description":"The billed quantity unit of measure.",
            "type":"string"
        },
        "billedQuantityUomType":{
            "description":"The billed quantity unit of measure type.",
            "type":"string"
        },
        "pricePerUnit":{
            "description":"The price per unit for the order release line to indicate the amount billed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalBilledAmt":{
            "description":"The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "brandName":{
            "description":"The brand name. For informational purposes.",
            "type":"string"
        },
        "hazIsNos":{
            "description":"A Y/N indicator defining this order release line as a hazardous not otherwise specified.",
            "type":"boolean"
        },
        "hazIsMarinePollutant":{
            "description":"A Y/N indicator defining this order as a marine pollutant.",
            "type":"boolean"
        },
        "hazErg":{
            "description":"The ERG (Emergency Response Guide) field. The page number is required for documentation purposes.",
            "type":"string"
        },
        "hazErgAir":{
            "description":"The ERG (Emergency Response Guide) field for air. The page number is required for documentation purposes.",
            "type":"string"
        },
        "hazEms":{
            "description":"The EMS (Emergency aboard Ship) field. The page number is required for documentation.",
            "type":"string"
        },
        "pricePerUnitUomCode":{
            "description":"The unit of measurement this unit price is based on.",
            "type":"string"
        },
        "hazCompatibilityGroup":{
            "description":"The hazardous material compatibility group associated to the order release line.",
            "type":"string"
        },
        "packageLength":{
            "description":"The package length for order release line; overrides length on packaged item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageWidth":{
            "description":"The package width for order release line; overrides width on packaged item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageHeight":{
            "description":"The package height for order release line; overrides height on packaged item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageDiameter":{
            "description":"The package diameter for order release line; overrides diameter on packaged item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packageCoreDiameter":{
            "description":"The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "orderBaseGid":{
            "description":"The order base from which this order release line was built. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "obLineGid":{
            "description":"The order base line from which this order release line was built.",
            "type":"string",
            "readOnly":true
        },
        "hazAllPacked":{
            "description":"Flag to indicate the package is \"All packed in one\".",
            "type":"boolean"
        },
        "hazAuthorization":{
            "description":"The authorization for the dangerous goods shipment. The authorization field is only required to state special governmental authorizations that are required because of the provisions or packing materials shipped with. ",
            "type":"string"
        },
        "hazChemicalFormula":{
            "description":"The basic chemical description of the substance.",
            "type":"string"
        },
        "hazConcentrationPercent":{
            "description":"Required if the dangerous goods UN number is 2031, 1796, 1826, or 1873. Enter the percentage of dangerous goods concentration if the above condition applies.",
            "type":"number",
            "format":"double"
        },
        "hazCritSafetyIndex":{
            "description":"A measurement for packages containing fissile material that is determined by dividing the number 50 by the smaller of the numbers determined using the rules in section 10.6.2.4.3 of the IATA Dangerous Goods Regulation Guide.",
            "type":"number",
            "format":"double"
        },
        "hazApprovalExemptionGid":{
            "description":"The hazardous approval exemption GID.",
            "type":"string"
        },
        "hazIdgAddDescInfo":{
            "description":"The hazmat IDG additional description information.",
            "type":"string"
        },
        "hazMaxQuantity":{
            "description":"The maximum passenger volume or the maximum cargo volume for the item. Used in Q- Value calculation.",
            "type":"number",
            "format":"double"
        },
        "hazOuterPackagingType":{
            "description":"Outer packaging type if packing type = All packed in one.",
            "type":"string"
        },
        "hazOuterPackingCount":{
            "description":"The outer packing count.",
            "type":"number",
            "format":"double"
        },
        "hazIsOverpack":{
            "description":"Flag to indicate the package is an \"overpack\".",
            "type":"boolean"
        },
        "hazPackageType":{
            "description":"The hazmat package type of the dangerous goods shipment.",
            "type":"string"
        },
        "hazPackingCount":{
            "description":"The packing count (number of packaged units).",
            "type":"number",
            "format":"double"
        },
        "hazPackingInstructions":{
            "description":"Required for dangerous goods shipments, unless the dangerous goods class is radioactive or not restricted. See Table 4.2 columns G, I, or K of the IATA Dangerous Goods Regulation Guide.",
            "type":"string"
        },
        "hazPhysicalForm":{
            "description":"A description of the physical form of the radioactive substance: S(p)ecial, (S)olid, (L)iquid, (G)as.",
            "type":"string"
        },
        "hazQValue":{
            "description":"The ratio used to indicate that the combined quantities in \"all packed in one\" package are within the maximum allowable limits.",
            "type":"number",
            "format":"double"
        },
        "hazQuantity":{
            "description":"The hazmat item quantity.",
            "type":"number",
            "format":"double"
        },
        "hazRadioactiveLabel":{
            "description":"The type of label on the shipment. W1 (White I), Y2 (Yellow II), Y3 (Yellow III).",
            "type":"string"
        },
        "hazRadPackaging":{
            "description":"A description of the type of packaging the substance is contained in. Acceptable package types are listed in section 10.5 of the dangerous goods regulations guide: Expected (Expected), Industrial ip1 (Industrial Type 1(IP-1)), Industrial ip2 (Industrial Type 2(IP-2)), Industrial ip3 (Industrial Type 3(IP-3)), Type a (Type A), Type b(m) ( Type B(M)), Type b(u) ( Type B(U)), Type c ( Type C ).",
            "type":"string"
        },
        "hazRadioactivity":{
            "description":"A measurement of the activity of the shipment. For fissile material, the weight of the material in grams or kilograms may be substituted for the activity measurement.",
            "type":"number",
            "format":"double"
        },
        "hazRadioactivityUnits":{
            "description":"The units that the activity were measured in. This must be in Becquerel units (or multiples thereof): Bq (Becquerel), kBq (kilobecquerel), MBq (megabecquerel), GBq (gigabecquerel), TBq (terabecquerel), PBq (petabecquerel).",
            "type":"string"
        },
        "hazRadionuclide":{
            "description":"The radionuclide assigned to the substance being shipped. A table of basic radionuclides is available in the IATA Dangerous Goods Regulation Guide section 10.4.A.  For example, aluminum (13) has a radionuclide Al-26.",
            "type":"string"
        },
        "hazSpecialProvisions":{
            "description":"Indicates dangerous goods (DG) are being shipped under one of the special provisions listed in the IATA Dangerous Goods Regulation Guide, section 4.4.  There appear to be 146 different provisions, and multiple provisions may apply to a single item in some cases. ",
            "type":"string"
        },
        "hazSubstanceNumber":{
            "description":"The hazardous materials substance number. ",
            "type":"string"
        },
        "hazSurfaceReading":{
            "description":"The surface reading of the radiation exposure for the package. This reading must be measured in mrem/h.",
            "type":"number",
            "format":"double"
        },
        "hazTransportIndex":{
            "description":"A number based on the radiation exposure of a package. This is determined based on the maximum measurement of the radiation in mrem/h at a distance of 1 meter from the package surface.",
            "type":"number",
            "format":"double"
        },
        "hazType":{
            "description":"The hazardous materials type. Valid values are: l = Limited Quantities, e = 500 KG Exemption, f = Fully Regulated (Purolater).",
            "type":"string"
        },
        "hazUnits":{
            "description":"IATA units for non UPS shipments (L=>Liters g=>Grams kg=>Kilograms kg G=>Kilograms Gross).",
            "type":"string"
        },
        "hazExtCode":{
            "description":"The item hazmat code as configured in the TNT EM. (For carrier TNT).",
            "type":"string"
        },
        "thuProfileGid":{
            "description":"The transport handling unit profile (list of valid THUs for this order line) that is to be used when building the order release ship unit. If defined here it will take precedence to the data that is defined on the static packaged item table.",
            "type":"string"
        },
        "obLineRelInstrSeq":{
            "description":"The order base line release instruction sequence number, carried over from column OB_RELEASE_INSTRUCTION_SEQ in table OB_RELEASE_INSTRUCTION when the order release line is created from an order base line.",
            "type":"number",
            "format":"int64"
        },
        "isSplitAllowed":{
            "description":"Indicates if the order release ship units that are created can be split into multiple pieces of equipment.",
            "type":"boolean"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "packWithGroup":{
            "description":"Lines with different Pack with Groups cannot be packed into the same ship unit.",
            "type":"string"
        },
        "loadConfigSetupGid":{
            "description":"A load configuration set up identifier to be used by the load configuration engine as the input rules during ship unit building.",
            "type":"string"
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "attributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.attributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "pruDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.pruDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "allocations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.allocations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocations

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.allocations"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.attributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

The declared cost of the item.

Match All

The declared cost of the item.

Show Source

• object currencyType

{
    "description":"The declared cost of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : freeAlongSide

Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.

Match All

Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.

Show Source

• object currencyType

{
    "description":"Refers to the seller's price quote for the goods, including the charge for delivery of the goods alongside a vessel at the named port of export.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : hazControlTemp

The hazardous control temperature to report for this order release line.

Match All

The hazardous control temperature to report for this order release line.

Show Source

• object amountType

{
    "description":"The hazardous control temperature to report for this order release line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : hazEmergencyTemp

The emergency temperature at which the product will begin the process of self-destructing or breaking down.

Match All

The emergency temperature at which the product will begin the process of self-destructing or breaking down.

Show Source

• object amountType

{
    "description":"The emergency temperature at which the product will begin the process of self-destructing or breaking down.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : hazFlashPoint

The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.

Match All

The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.

Show Source

• object amountType

{
    "description":"The hazardous flash point for this material is the lowest temperature at which the vapor of the material (if it is a combustible liquid) can be made to ignite momentarily in air. Enter a numeric value if applicable and select K for Kelvin, F for Fahrenheit, or C for Centigrade as the temperature type.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : hazNetExplosvContentWeight

The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.

Match All

The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.

Show Source

• object amountType

{
    "description":"The hazardous net explosive content weight is the net weight of the explosive contents of the order release line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : initialItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : packageCoreDiameter

The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.

Match All

The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.

Show Source

• object amountType

{
    "description":"The package core diameter for order release line; overrides core diameter on packaged item. Used for products such as roll of paper that have different dimensions.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageDiameter

The package diameter for order release line; overrides diameter on packaged item.

Match All

The package diameter for order release line; overrides diameter on packaged item.

Show Source

• object amountType

{
    "description":"The package diameter for order release line; overrides diameter on packaged item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : packageHeight

The package height for order release line; overrides height on packaged item.

Match All

The package height for order release line; overrides height on packaged item.

Show Source

• object amountType

{
    "description":"The package height for order release line; overrides height on packaged item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageLength

The package length for order release line; overrides length on packaged item.

Match All

The package length for order release line; overrides length on packaged item.

Show Source

• object amountType

{
    "description":"The package length for order release line; overrides length on packaged item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : packageWidth

The package width for order release line; overrides width on packaged item.

Match All

The package width for order release line; overrides width on packaged item.

Show Source

• object amountType

{
    "description":"The package width for order release line; overrides width on packaged item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pricePerUnit

The price per unit for the order release line to indicate the amount billed.

Match All

The price per unit for the order release line to indicate the amount billed.

Show Source

• object currencyType

{
    "description":"The price per unit for the order release line to indicate the amount billed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : pruDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.pruDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryVolume

The order release line can be specified in a secondary volume value for informational purposes.

Match All

The order release line can be specified in a secondary volume value for informational purposes.

Show Source

• object amountType

{
    "description":"The order release line can be specified in a secondary volume value for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondaryWeight

The order release line can be specified in a secondary weight value for informational purposes.

Match All

The order release line can be specified in a secondary weight value for informational purposes.

Show Source

• object amountType

{
    "description":"The order release line can be specified in a secondary weight value for informational purposes.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalBilledAmt

The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.

Match All

The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.

Show Source

• object currencyType

{
    "description":"The total billed amount to the customer for the line. It can contain handling and additional costs beyond goods.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : volume

The volume of the item.

Match All

The volume of the item.

Show Source

• object amountType

{
    "description":"The volume of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight of the item.

Match All

The weight of the item.

Show Source

• object amountType

{
    "description":"The weight of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• links: array links
  Read Only: true
• remarks: remarks

{
    "properties":{
        "accessorialCodeGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.accessorials.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.accessorials.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.accessorials.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The remark sequence associated with the order release line
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence associated with the order release line",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.allocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• allocationBase: allocationBase
• allocSeqNo: number (int64)
  No description.
• baseCost: baseCost
  No description.
• details: details
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• links: array links
  Read Only: true
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  A unique identifier created by the system for the order release. the gid contains the domain portion.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• privateCost: privateCost
  No description.
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• totalAllocLineCost: totalAllocLineCost
  No description.

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "orderReleaseGid":{
            "description":"A unique identifier created by the system for the order release. the gid contains the domain portion. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "privateCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "baseCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalAllocLineCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packagedItemGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "allocationBase":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.allocations.allocationBase"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.lines.allocations.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocationBase

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.allocations.allocationBase"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : baseCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : details

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.lines.allocations.details"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : privateCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : totalAllocLineCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.allocations.allocationBase"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• allocatedCost: allocatedCost
  No description.
• allocSeqNo: number (int64)
  No description.
• allocTypeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• invoice: invoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• invoiceGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true
• parentInvoice: parentInvoice
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• parentInvoiceGid: string
  If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipGroup: shipGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipGroupGid: string
  Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
  group.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• timestamp: timestamp
  No description.
• voucher: voucher
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voucherGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "invoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"If populated, the INVOICE_GID indicates that this alllocation is for a child invoice.  This column indicates the parent invoice of the entire consolidation that was allocated. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "parentInvoice":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/bills"
                }
            ],
            "readOnly":true
        },
        "voucherGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voucher":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/vouchers"
                }
            ],
            "readOnly":true
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : invoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property invoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : parentInvoice

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object bills

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property parentInvoiceGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/bills"
        }
    ],
    "readOnly":true
}

Nested Schema : shipGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : timestamp

No description.

Match All

No description.

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : voucher

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object vouchers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/vouchers"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.allocations.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release line record.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based Shipment.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher or invoice

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release line record.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based Shipment.",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher or invoice",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.attributes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemFeatureQualGid: string
  The item feature qualifier GID defining what type of feature with which this value is associated.
• itemFeatureValue: string
  The item feature value for the order release line. This allows for future structural definition of an item such as size and color.
• links: array links
  Read Only: true

{
    "properties":{
        "itemFeatureQualGid":{
            "description":"The item feature qualifier GID defining what type of feature with which this value is associated.",
            "type":"string"
        },
        "itemFeatureValue":{
            "description":"The item feature value for the order release line. This allows for future structural definition of an item such as size and color.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.equipmentRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The equipment reference unit GID for the order line.
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of ref units per package for the equipment reference unit GID on this line.
• totalNumReferenceUnits: number (double)
  The total number of reference units for the equipment reference unit on this line.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference unit GID for the order line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The number of ref units per package for the equipment reference unit GID on this line.",
            "type":"number",
            "format":"double"
        },
        "totalNumReferenceUnits":{
            "description":"The total number of reference units for the equipment reference unit on this line.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  The communication method ID for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The contact ID for the involved party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The qualifier ID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier ID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact ID for the involved party. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method ID for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.pruDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The packaging reference unit GID. The package reference unit (PRU) defines another dimension to describe the consumption and capacity associated to building the order release ship units for transport. An example could be value of goods, loading meters, etc.
• totalPruCount: number (double)
  The total packaging unit reference (PRU) count being described as how much of the PRU does this line consume against the upper limit.
• unitPruCount: number (double)
  The packaging unit reference (PRU) count being described as how much of the PRU does this line consume.

{
    "properties":{
        "packagingReferenceUnitGid":{
            "description":"The packaging reference unit GID. The package reference unit (PRU) defines another dimension to describe the consumption and capacity associated to building the order release ship units for transport. An example could be value of goods, loading meters, etc.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "unitPruCount":{
            "description":"The packaging unit reference (PRU) count being described as how much of the PRU does this line consume.",
            "type":"number",
            "format":"double"
        },
        "totalPruCount":{
            "description":"The total packaging unit reference (PRU) count being described as how much of the PRU does this line consume against the upper limit.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• orderReleaseRefnumQualGid: string
  The reference number qualifier GID defining the reference code.
• orlRefnumValue: string
  The text associated to the remark code.

{
    "properties":{
        "orderReleaseRefnumQualGid":{
            "description":"The reference number qualifier GID defining the reference code.",
            "type":"string"
        },
        "orlRefnumValue":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier GID defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the order base line.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the order base line.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier GID defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceCodeGid: string
  The special service code GID.

{
    "properties":{
        "specialServiceCodeGid":{
            "description":"The special service code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.lines.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  A document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  The transactional override for the template on the specific document.
• textTemplateGid: string
  The text template qualifier GID defining the text.

{
    "properties":{
        "textTemplateGid":{
            "description":"The text template qualifier GID defining the text.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"A document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"The transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• availableByDate: availableByDate
  The date the freight will be available by if the shipment will not be available to ship until a certain date.
• consolidationTypeGid: string
  Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.
• costOptions: costOptions
• deliverByDate: deliverByDate
  The date the freight must be delivered by if the shipment must be delivered by a certain date.
• destinationAddressLine1: string
  Destination location address line 1 value.
• destinationAddressLine2: string
  Destination location address line 2 value.
• destinationAddressLine3: string
  Destination location address line 3 value.
• destinationCity: string
  Destination location city value.
• destinationCountryCode3Gid: string
  Destination Location country code value.
• destinationLocation: destinationLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destinationLocationGid: string
  The GID for the destination location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• destinationLocationType: string
  Type of location for the destination location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Destination and Destination.
• destinationPostalCode: string
  Destination location postal code value.
• destinationProvince: string
  Destination location province value.
• destinationSearchValue: string
  Destination rate search value.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• equipmentGroups: equipmentGroups
• expirationDate: expirationDate
  Identifies the last day the quote is valid.
• incoTermGid: string
  The GID for the Incoterm for the shipment. This can limit the itineraries considered.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isCustomerRatesOnly: boolean
  Flag to limit search to customer specific rates only.
• isHazardous: boolean
  Flag indicating if the quote is for a shipment that contains hazardous material.
• issueDate: issueDate
  The date the quote was sent to the customer.
• links: array links
  Read Only: true
• originAddressLine1: string
  Origin location address line 1 value.
• originAddressLine2: string
  Origin location address line 2 value.
• originAddressLine3: string
  Origin location address line 3 value.
• originCity: string
  Origin location city value.
• originCountryCode3Gid: string
  Origin location country code value.
• originLocation: originLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property originLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• originLocationGid: string
  The GID for the origin/source location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• originLocationType: string
  Type of location for the source location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Origin and Destination.
• originPostalCode: string
  Origin location postal code value.
• originProvince: string
  Origin location province value.
• originSearchValue: string
  Origin rate search value.
• perspective: string
  Perspective - buy or sell side.
• quoteGid: string
  The GID for the quote.
• quoteOption: string
  Select Optimize, Equipment Groups, or Equipment Configuration.
  Optimize returns quotes that match the search criteria. This is the default setting.
  Equipment Groups limit the search to specific Equipment Groups. When you select this option, an Equipment Group field appears where you can enter or search for an Equipment Group. Use the Save button to enter multiple Equipment Groups.
  Equipment Configuration works like the Equipment Groups option, but it provides you with a field to enter the number of Equipment Groups you require.
• quoteXid: string
  The XID for the quote.
• refnums: refnums
• remarks: remarks
• requestDate: requestDate
  The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The GID for the service provider for the quote. Enter the service provider that you want to use for the master leg of the shipment. The values available in this field match what is defined in the Service Provider Manager.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipUnits: shipUnits
• statuses: statuses
• texts: texts
• transportModeGid: string
  The GID for the transport mode to for the quote. Select the mode that you want the master leg of the shipment to be transported on. The values in this drop-down list match the Transport Modes defined in Power Data.
• updateDate: updateDate
  Read Only: true

  update date
• viaDestinationLocation: viaDestinationLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property viaDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• viaDestinationLocationGid: string
  Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• viaOriginLocation: viaOriginLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property viaOriginLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• viaOriginLocationGid: string
  If applicable, the GID for the origin via location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "quoteGid":{
            "description":"The GID for the quote.",
            "type":"string"
        },
        "quoteXid":{
            "description":"The XID for the quote.",
            "type":"string"
        },
        "requestDate":{
            "description":"The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "issueDate":{
            "description":"The date the quote was sent to the customer.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expirationDate":{
            "description":"Identifies the last day the quote is valid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originLocationType":{
            "description":"Type of location for the source location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Origin and Destination.",
            "type":"string"
        },
        "originLocationGid":{
            "description":"The GID for the origin/source location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "originLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "originAddressLine1":{
            "description":"Origin location address line 1 value.",
            "type":"string"
        },
        "originAddressLine2":{
            "description":"Origin location address line 2 value.",
            "type":"string"
        },
        "originAddressLine3":{
            "description":"Origin location address line 3 value.",
            "type":"string"
        },
        "originCity":{
            "description":"Origin location city value.",
            "type":"string"
        },
        "originProvince":{
            "description":"Origin location province value.",
            "type":"string"
        },
        "originCountryCode3Gid":{
            "description":"Origin location country code value.",
            "type":"string"
        },
        "originPostalCode":{
            "description":"Origin location postal code value.",
            "type":"string"
        },
        "viaOriginLocationGid":{
            "description":"If applicable, the GID for the origin via location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "viaOriginLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property viaOriginLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destinationLocationType":{
            "description":"Type of location for the destination location - equivalent to location role. Examples would include: Port, Rail Ramp etc. This limits the location search to these specific types of locations. The default Location Type is Location Code for both the Destination and Destination.",
            "type":"string"
        },
        "destinationLocationGid":{
            "description":"The GID for the destination location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destinationLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destinationAddressLine1":{
            "description":"Destination location address line 1 value.",
            "type":"string"
        },
        "destinationAddressLine2":{
            "description":"Destination location address line 2 value.",
            "type":"string"
        },
        "destinationAddressLine3":{
            "description":"Destination location address line 3 value.",
            "type":"string"
        },
        "destinationCity":{
            "description":"Destination location city value.",
            "type":"string"
        },
        "destinationProvince":{
            "description":"Destination location province value.",
            "type":"string"
        },
        "destinationCountryCode3Gid":{
            "description":"Destination Location country code value.",
            "type":"string"
        },
        "destinationPostalCode":{
            "description":"Destination location postal code value.",
            "type":"string"
        },
        "viaDestinationLocationGid":{
            "description":"Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "viaDestinationLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property viaDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "isHazardous":{
            "description":"Flag indicating if the quote is for a shipment that contains hazardous material.",
            "type":"boolean"
        },
        "perspective":{
            "description":"Perspective - buy or sell side.",
            "type":"string"
        },
        "quoteOption":{
            "description":"Select Optimize, Equipment Groups, or Equipment Configuration.<br>Optimize returns quotes that match the search criteria. This is the default setting.<br>Equipment Groups limit the search to specific Equipment Groups. When you select this option, an Equipment Group field appears where you can enter or search for an Equipment Group. Use the Save button to enter multiple Equipment Groups.<br>Equipment Configuration works like the Equipment Groups option, but it provides you with a field to enter the number of Equipment Groups you require.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The GID for the transport mode to for the quote. Select the mode that you want the master leg of the shipment to be transported on. The values in this drop-down list match the Transport Modes defined in Power Data.",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the service provider for the quote. Enter the service provider that you want to use for the master leg of the shipment. The values available in this field match what is defined in the Service Provider Manager. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "availableByDate":{
            "description":"The date the freight will be available by if the shipment will not be available to ship until a certain date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "deliverByDate":{
            "description":"The date the freight must be delivered by if the shipment must be delivered by a certain date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originSearchValue":{
            "description":"Origin rate search value.",
            "type":"string"
        },
        "destinationSearchValue":{
            "description":"Destination rate search value.",
            "type":"string"
        },
        "isCustomerRatesOnly":{
            "description":"Flag to limit search to customer specific rates only.",
            "type":"boolean"
        },
        "consolidationTypeGid":{
            "description":"Job consolidation type to be used when determining the NFRC rules that may apply to this quote rate inquiry.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The GID for the Incoterm for the shipment. This can limit the itineraries considered.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.shipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentGroups":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.equipmentGroups"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costOptions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : availableByDate

The date the freight will be available by if the shipment will not be available to ship until a certain date.

Match All

The date the freight will be available by if the shipment will not be available to ship until a certain date.

Show Source

• object dateTimeType

{
    "description":"The date the freight will be available by if the shipment will not be available to ship until a certain date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : costOptions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : deliverByDate

The date the freight must be delivered by if the shipment must be delivered by a certain date.

Match All

The date the freight must be delivered by if the shipment must be delivered by a certain date.

Show Source

• object dateTimeType

{
    "description":"The date the freight must be delivered by if the shipment must be delivered by a certain date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : destinationLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroups

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.equipmentGroups"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : expirationDate

Identifies the last day the quote is valid.

Match All

Identifies the last day the quote is valid.

Show Source

• object dateTimeType

{
    "description":"Identifies the last day the quote is valid.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : issueDate

The date the quote was sent to the customer.

Match All

The date the quote was sent to the customer.

Show Source

• object dateTimeType

{
    "description":"The date the quote was sent to the customer.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : originLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property originLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property originLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property originLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : requestDate

The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.

Match All

The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.

Show Source

• object dateTimeType

{
    "description":"The date that you received the request for the quote from the customer. If you leave this field blank, it defaults to the date that the quote is created.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : shipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.shipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : viaDestinationLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property viaDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property viaDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property viaDestinationLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : viaOriginLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property viaOriginLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property viaOriginLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property viaOriginLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• buyItinerary: buyItinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property buyItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• buyItineraryGid: string
  Database base amount for total non-transport costs for sell side of this quote option.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• buyNonTransCost: buyNonTransCost
  Total non-transport costs for buy side of this quote option.
• buyTransCost: buyTransCost
  Total non-transport costs for buy side of this quote option.
• costOptionSequence: number (int32)
  Option Number: Each possible cost option is assigned an Option Number.
• domainName: string
  Database domain where this data is stored.
• equipments: equipments
• isFeasibleBuy: boolean
  Currency for total non-transport costs for sell side of this quote option.
• isFeasibleSell: boolean
  Indicates if the buy side option is feasible.
• isLateBuy: boolean
  Total non-transport costs for sell side of this quote option.
• isLateSell: boolean
  Indicates if the buy side option is late.
• links: array links
  Read Only: true
• remarks: remarks
• sellItinerary: sellItinerary
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sellItineraryGid: string
  Itinerary used for the buy side option.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sellNonTransCost: sellNonTransCost
  Total non-transport costs for sell side of this quote option.
• sellTransCost: sellTransCost
  Total buy side transport cost for this quote option
• shipments: shipments

{
    "properties":{
        "costOptionSequence":{
            "description":"Option Number: Each possible cost option is assigned an Option Number.",
            "type":"number",
            "format":"int32"
        },
        "sellTransCost":{
            "description":"Total buy side transport cost for this quote option",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isLateSell":{
            "description":"Indicates if the buy side option is late.",
            "type":"boolean"
        },
        "isFeasibleSell":{
            "description":"Indicates if the buy side option is feasible.",
            "type":"boolean"
        },
        "sellItineraryGid":{
            "description":"Itinerary used for the buy side option. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sellItinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "buyTransCost":{
            "description":"Total non-transport costs for buy side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isLateBuy":{
            "description":"Total non-transport costs for sell side of this quote option.",
            "type":"boolean"
        },
        "isFeasibleBuy":{
            "description":"Currency for total non-transport costs for sell side of this quote option.",
            "type":"boolean"
        },
        "buyItineraryGid":{
            "description":"Database base amount for total non-transport costs for sell side of this quote option. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "buyItinerary":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property buyItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itineraries"
                }
            ],
            "readOnly":true
        },
        "buyNonTransCost":{
            "description":"Total non-transport costs for buy side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "sellNonTransCost":{
            "description":"Total non-transport costs for sell side of this quote option.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "shipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.shipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.equipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : buyItinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property buyItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property buyItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property buyItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : buyNonTransCost

Total non-transport costs for buy side of this quote option.

Match All

Total non-transport costs for buy side of this quote option.

Show Source

• object currencyType

{
    "description":"Total non-transport costs for buy side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : buyTransCost

Total non-transport costs for buy side of this quote option.

Match All

Total non-transport costs for buy side of this quote option.

Show Source

• object currencyType

{
    "description":"Total non-transport costs for buy side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : equipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.equipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sellItinerary

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sellItineraryGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itineraries"
        }
    ],
    "readOnly":true
}

Nested Schema : sellNonTransCost

Total non-transport costs for sell side of this quote option.

Match All

Total non-transport costs for sell side of this quote option.

Show Source

• object currencyType

{
    "description":"Total non-transport costs for sell side of this quote option.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : sellTransCost

Total buy side transport cost for this quote option

Match All

Total buy side transport cost for this quote option

Show Source

• object currencyType

{
    "description":"Total buy side transport cost for this quote option",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : shipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.shipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions.equipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupCount: number (int32)
  Count for the equipment group assigned to the cost option.
• equipmentGroupGid: string
  The GID for the equipment group for this option.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group for this option. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "equipmentGroupCount":{
            "description":"Count for the equipment group assigned to the cost option.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The GID for the remark qualifier.
• remarkSequence: number (int32)
  Internal sequence number for the remark.
• remarkText: string
  Remark text related to the remark qualifier.

{
    "properties":{
        "remarkSequence":{
            "description":"Internal sequence number for the remark.",
            "type":"number",
            "format":"int32"
        },
        "remarkQualGid":{
            "description":"The GID for the remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remark text related to the remark qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions.shipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• actualCost: actualCost
  Actual cost.
• costs: costs
• destinationAddressLine1: string
  Destination location address line 1 value.
• destinationAddressLine2: string
  Destination location address line 2 value.
• destinationAddressLine3: string
  Destination location address line 3 value.
• destinationCity: string
  Destination location city value.
• destinationCountryCode3Gid: string
  Destination Location country code value.
• destinationPostalCode: string
  Destination location postal code value.
• destinationProvince: string
  Destination location province value.
• destLocation: destLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destLocationGid: string
  The GID for the Destination location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• destLocationName: string
  Destination location name.
• destViaLocation: destViaLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destViaLocationGid: string
  The GID for the destination via location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• distance: distance
  Distance.
• domainName: string
  Database domain where this data is stored.
• endTime: endTime
  The Start Time and End Time fields specify when the shipment must leave and arrive by.
• flightGid: string
  The GID for the flight that must be used.
• isPrimary: boolean
  The Primary check box is used to specify if this is the primary leg of the shipment.
• links: array links
  Read Only: true
• nfrcRuleGid: string
  The NFRC rule used to create this shipment if it is an NFRC and was created by the system.
• perspective: string
  Perspective - Buy or Sell.
• rateExpiration: rateExpiration
  Expiration data of the rate.
• rateFromLocation: rateFromLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property rateFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• rateFromLocationGid: string
  The GID for the rating from location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• rateGeoGid: string
  The GID for the rate record that should be used. This rates the cost option leg for the given rate record.
• rateOfferingGid: string
  The GID for the rate offering that should be used.
• rateToLocation: rateToLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property rateToLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• rateToLocationGid: string
  The GID for the rating to location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• servprov: servprov
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• servprovGid: string
  The GID for the service provider that should be used.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentSequence: number (int32)
  Internal sequence number for shipment information provide as part of the quote option.
• shipmentTypeGid: string
  Indicates the shipment type for this quote cost option shipment.
• sourceAddressLine1: string
  Source location address line 1 value.
• sourceAddressLine2: string
  Source location address line 2 value.
• sourceAddressLine3: string
  Source location address line 3 value.
• sourceCity: string
  Source location city value.
• sourceCountryCode3Gid: string
  Source Location country code value.
• sourceLocation: sourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourceLocationGid: string
  The GID for the source location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sourceLocationName: string
  Source location name.
• sourcePostalCode: string
  Source location postal code value.
• sourceProvince: string
  Source location province value.
• sourceViaLocation: sourceViaLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourceViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourceViaLocationGid: string
  The GID for the source via location.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• startTime: startTime
  The Start Time and End Time fields specify when the shipment must leave and arrive by.
• transportModeGid: string
  The GID for the transport mode that should be used.
• voyage: voyage
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voyageGid: string
  The GID for the voyage that must be used.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "shipmentSequence":{
            "description":"Internal sequence number for shipment information provide as part of the quote option. ",
            "type":"number",
            "format":"int32"
        },
        "isPrimary":{
            "description":"The Primary check box is used to specify if this is the primary leg of the shipment.",
            "type":"boolean"
        },
        "actualCost":{
            "description":"Actual cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "servprovGid":{
            "description":"The GID for the service provider that should be used. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "servprov":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/serviceProviders"
                }
            ],
            "readOnly":true
        },
        "transportModeGid":{
            "description":"The GID for the transport mode that should be used.",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"The GID for the rate offering that should be used.",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"The GID for the rate record that should be used. This rates the cost option leg for the given rate record. ",
            "type":"string"
        },
        "flightGid":{
            "description":"The GID for the flight that must be used.",
            "type":"string"
        },
        "rateFromLocationGid":{
            "description":"The GID for the rating from location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "rateFromLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property rateFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "rateToLocationGid":{
            "description":"The GID for the rating to location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "rateToLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property rateToLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sourceViaLocationGid":{
            "description":"The GID for the source via location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourceViaLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destViaLocationGid":{
            "description":"The GID for the destination via location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destViaLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "voyageGid":{
            "description":"The GID for the voyage that must be used. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voyage":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/voyages"
                }
            ],
            "readOnly":true
        },
        "distance":{
            "description":"Distance.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "perspective":{
            "description":"Perspective - Buy or Sell.",
            "type":"string"
        },
        "rateExpiration":{
            "description":"Expiration data of the rate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID for the source location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "sourceLocationName":{
            "description":"Source location name.",
            "type":"string"
        },
        "sourceAddressLine1":{
            "description":"Source location address line 1 value.",
            "type":"string"
        },
        "sourceAddressLine2":{
            "description":"Source location address line 2 value.",
            "type":"string"
        },
        "sourceAddressLine3":{
            "description":"Source location address line 3 value.",
            "type":"string"
        },
        "sourceCity":{
            "description":"Source location city value.",
            "type":"string"
        },
        "sourceProvince":{
            "description":"Source location province value.",
            "type":"string"
        },
        "sourceCountryCode3Gid":{
            "description":"Source Location country code value.",
            "type":"string"
        },
        "sourcePostalCode":{
            "description":"Source location postal code value.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The GID for the Destination location. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destLocationName":{
            "description":"Destination location name.",
            "type":"string"
        },
        "destinationAddressLine1":{
            "description":"Destination location address line 1 value.",
            "type":"string"
        },
        "destinationAddressLine2":{
            "description":"Destination location address line 2 value.",
            "type":"string"
        },
        "destinationAddressLine3":{
            "description":"Destination location address line 3 value.",
            "type":"string"
        },
        "destinationCity":{
            "description":"Destination location city value.",
            "type":"string"
        },
        "destinationProvince":{
            "description":"Destination location province value.",
            "type":"string"
        },
        "destinationCountryCode3Gid":{
            "description":"Destination Location country code value.",
            "type":"string"
        },
        "destinationPostalCode":{
            "description":"Destination location postal code value.",
            "type":"string"
        },
        "shipmentTypeGid":{
            "description":"Indicates the shipment type for this quote cost option shipment.",
            "type":"string"
        },
        "nfrcRuleGid":{
            "description":"The NFRC rule used to create this shipment if it is an NFRC and was created by the system.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualCost

Actual cost.

Match All

Actual cost.

Show Source

• object currencyType

{
    "description":"Actual cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : costs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : destLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : destViaLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : distance

Distance.

Match All

Distance.

Show Source

• object amountType

{
    "description":"Distance.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : endTime

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Match All

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Show Source

• object dateTimeType

{
    "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : rateExpiration

Expiration data of the rate.

Match All

Expiration data of the rate.

Show Source

• object dateType

{
    "description":"Expiration data of the rate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : rateFromLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property rateFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property rateFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property rateFromLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : rateToLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property rateToLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property rateToLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property rateToLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : servprov

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property servprovGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/serviceProviders"
        }
    ],
    "readOnly":true
}

Nested Schema : sourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : sourceViaLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceViaLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : startTime

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Match All

The Start Time and End Time fields specify when the shipment must leave and arrive by.

Show Source

• object dateTimeType

{
    "description":"The Start Time and End Time fields specify when the shipment must leave and arrive by.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : voyage

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voyageGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/voyages"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.costOptions.shipments.costs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial cost (if any) on the quote cost option.
• cost: cost
  Cost.
• costExplanation: string
  Explanation for cost.
• costSequence: number (int32)
  Cost sequence number for different cost provided for the quote cost option.
• costType: string
  Cost type - e.g., Base Cost, Accessorial etc.
• description: string
  Description.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• paymentMethodCodeGid: string
  Indicates the payment method that applies to this quote shipment cost.

{
    "properties":{
        "costSequence":{
            "description":"Cost sequence number for different cost provided for the quote cost option.",
            "type":"number",
            "format":"int32"
        },
        "costType":{
            "description":"Cost type - e.g., Base Cost, Accessorial etc.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial cost (if any) on the quote cost option.",
            "type":"string"
        },
        "cost":{
            "description":"Cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "description":{
            "description":"Description.",
            "type":"string"
        },
        "costExplanation":{
            "description":"Explanation for cost.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"Indicates the payment method that applies to this quote shipment cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

Cost.

Match All

Cost.

Show Source

• object currencyType

{
    "description":"Cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object quotes.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : quotes.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.equipmentGroups"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentGroup: equipmentGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• equipmentGroupCount: number (int64)
  Count for the equipment group assigned to the cost option.
• equipmentGroupGid: string
  The GID for the equipment group for this option.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• links: array links
  Read Only: true

{
    "properties":{
        "equipmentGroupGid":{
            "description":"The GID for the equipment group for this option. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/equipmentGroups"
                }
            ],
            "readOnly":true
        },
        "equipmentGroupCount":{
            "description":"Count for the equipment group assigned to the cost option.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipmentGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property equipmentGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/equipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• comMethodGid: string
  Communication method.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  Involved party related to the qualifier.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The GID for the involved party qualifier.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for the involved party qualifier.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"Involved party related to the qualifier. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"Communication method.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• quoteRefnumQualGid: string
  The GID for the reference number qualifier.
• quoteRefnumValue: string
  Reference number value related to the reference number qualifier.

{
    "properties":{
        "quoteRefnumQualGid":{
            "description":"The GID for the reference number qualifier.",
            "type":"string"
        },
        "quoteRefnumValue":{
            "description":"Reference number value related to the reference number qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualifierGid: string
  A qualifier for the remark.
• remarkSequence: number (int64)
  The sequence to keep remarks unique. It allows multiple of the same qualifier.
• remarkText: string
  The text of the remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence to keep remarks unique. It allows multiple of the same qualifier.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualifierGid":{
            "description":"A qualifier for the remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.shipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• commodityGid: string
  The unique identifier for the commodity.
• commodityType: string
  The type of commodity.
• declaredValue: declaredValue
  Declared value.
• domainName: string
  Database domain where this data is stored.
• exportHtsGid: string
  The unique identifier for the export Harmonized Tariff System (HTS).
• height: height
  Height.
• htsGid: string
  The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.
• iataScrCodeGid: string
  n/a
• isSplitable: boolean
  Flag to indicate if the quantity for this item is splittable.
• item: item
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• itemGid: string
  The GID for the item.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• length: length
  Length.
• links: array links
  Read Only: true
• nmfcClassGid: string
  The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc.
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  Identifies the package item corresponding to the item
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sequence: number (int32)
  Sequence number for the ship unit.
• shipUnitCount: number (int32)
  Count of transport handling units.
• sitcGid: string
  The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.
• stccGid: string
  The GID for the Standard Transportation Commodity Code (STCC).
• transportHandlingUnitGid: string
  The GID for the transport handling unit.
• udcClassificationListGid: string
  The GID for the user defined commodity code list.
• userDefinedCommodityGid: string
  The GID for the user defined commodity code.
• volume: volume
  Volume.
• weight: weight
  Weight.
• width: width
  Width.

{
    "properties":{
        "sequence":{
            "description":"Sequence number for the ship unit.",
            "type":"number",
            "format":"int32"
        },
        "commodityType":{
            "description":"The type of commodity.",
            "type":"string"
        },
        "itemGid":{
            "description":"The GID for the item. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "item":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "nmfcClassGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc. ",
            "type":"string"
        },
        "stccGid":{
            "description":"The GID for the Standard Transportation Commodity Code (STCC).",
            "type":"string"
        },
        "sitcGid":{
            "description":"The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "htsGid":{
            "description":"The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for the user defined commodity code.",
            "type":"string"
        },
        "udcClassificationListGid":{
            "description":"The GID for the user defined commodity code list.",
            "type":"string"
        },
        "weight":{
            "description":"Weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplitable":{
            "description":"Flag to indicate if the quantity for this item is splittable.",
            "type":"boolean"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "shipUnitCount":{
            "description":"Count of transport handling units.",
            "type":"number",
            "format":"int32"
        },
        "length":{
            "description":"Length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"Width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"Height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"Declared value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "iataScrCodeGid":{
            "description":"n/a",
            "type":"string"
        },
        "commodityGid":{
            "description":"The unique identifier for the commodity.",
            "type":"string"
        },
        "exportHtsGid":{
            "description":"The unique identifier for the export Harmonized Tariff System (HTS).",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagedItemGid":{
            "description":"Identifies the package item corresponding to the item <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

Declared value.

Match All

Declared value.

Show Source

• object currencyType

{
    "description":"Declared value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : height

Height.

Match All

Height.

Show Source

• object amountType

{
    "description":"Height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : item

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property itemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : length

Length.

Match All

Length.

Show Source

• object amountType

{
    "description":"Length.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : volume

Volume.

Match All

Volume.

Show Source

• object amountType

{
    "description":"Volume.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

Weight.

Match All

Weight.

Show Source

• object amountType

{
    "description":"Weight.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

Width.

Match All

Width.

Show Source

• object amountType

{
    "description":"Width.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The GID for the status type.
• statusValueGid: string
  Value of status type

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the status type.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  Document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for text template. A Text Template is a predefined, formatted selection of text that is identified by an Oracle Transportation Management business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for text template. A Text Template is a predefined, formatted selection of text that is identified by an Oracle Transportation Management business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet). ",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• orderReleaseRefnumQualGid: string
  The reference qualifier GID defining the reference code.
• orderReleaseRefnumValue: string
  The value associated to the reference code.

{
    "properties":{
        "orderReleaseRefnumQualGid":{
            "description":"The reference qualifier GID defining the reference  code.",
            "type":"string"
        },
        "orderReleaseRefnumValue":{
            "description":"The value associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
• remarkSequence: number (int64)
  The remark sequence (key) associated with the order release remarks.
• remarkText: string
  A user-entered remark on the order release.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence (key) associated with the order release remarks.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.",
            "type":"string"
        },
        "remarkText":{
            "description":"A user-entered remark on the order release.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.services"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• customerServiceGid: string
  The customer service GID for this customer service.
• domainName: string
  Database domain where this data is stored.
• executedDate: executedDate
  It will be reset to the date when this service template is applied last time.
• isProrityOverwrite: boolean
  If this field is Y, this customer service will be treated as the highest priority. It will be reset to N after the service template is applied.
• links: array links
  Read Only: true

{
    "properties":{
        "customerServiceGid":{
            "description":"The customer service GID for this customer service.",
            "type":"string"
        },
        "executedDate":{
            "description":"It will be reset to the date when this service template is applied last time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isProrityOverwrite":{
            "description":"If this field is Y, this customer service will be treated as the highest priority. It will be reset to N after the service template is applied.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : executedDate

It will be reset to the date when this service template is applied last time.

Match All

It will be reset to the date when this service template is applied last time.

Show Source

• object dateTimeType

{
    "description":"It will be reset to the date when this service template is applied last time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• coreDiameter: coreDiameter
  For cylindrical objects, this defines the diameter of the core
• domainName: string
  Database domain where this data is stored.
• dropoffOrStopGid: string
  This ship unit is going to be dropped off at this stop. If this field is empty, this ship unit is dropped off at the order's destination location.
• equipmentRefUnits: equipmentRefUnits
• flexCommodityCode: string
  The user defined commodity code for the item. E.g.. the HTS, NMFC, SITC, STCC codes for the item.
• flexCommodityQualGid: string
  A unique identifier to define the type of the code. E.g.. HTS, SITC, STCC, NMFC etc.
• isAllowRepack: boolean
  A Y/N field, if this flag is set to false, when planning order movement that contains this shipment ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this s ship unit.
• isCountSplittable: boolean
  A Y/N indicator for whether the ship unit can be split on the count boundaries when planning during container optimization.
• isExclusiveUse: boolean
  Used to specify if the ship unit is EXCLUSIVE USE. Ship unit is not mixed with anything even if they belong to the same MIXING family if its marked as EXCLUSIVE USE.
• isSplitable: boolean
  A Y/N flag to identify if the ship unit can be split when creating an order.
• isSystemGenerated: boolean
  A Y/N indicator to define if the record is generated by the system for the order base or copied (may be from XML).
• lines: lines
• links: array links
  Read Only: true
• loadConfigSetupGid: string
  A load configurator set up identifier to be used by the load configuration engine as the input rules for how the ship unit was built.
• loadingSplits: loadingSplits
• obShipUnitGid: string
  Read Only: true

  The order base ship unit associated with the order release ship unit if it was created from an order base and the releasing logic.
• obSuReleaseInstrSeq: number (int64)
  Read Only: true

  The release instruction associated to the order base if the order release was created from an order base through the releasing logic.
• orEquipmentSeq: number (int32)
  Associates equipment of the order release to this particular ship unit.
• pickupOrStopGid: string
  This ship unit is going to be picked up at this stop. If this field is empty, this ship unit is picked up at the order's source location.
• priority: number (int32)
  This column defines the priority associated with a ship unit.
• refnums: refnums
• remarks: remarks
• seals: seals
• secondaryUnitVolume: secondaryUnitVolume
  An additional value for the secondary gross volume of the ship unit.
• secondaryUnitWeight: secondaryUnitWeight
  An additional value for the secondary gross weight of the ship unit.
• secondryUnitNetVol: secondryUnitNetVol
  An additional value for the secondary net volume of the ship unit.
• secondryUnitNetWt: secondryUnitNetWt
  An additional value for the secondary net weight of the ship unit.
• shipUnitCount: number (int64)
  Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. The ship unit count is the number of these ship units.
• shipUnitGid: string
  The GID for the ship unit associated to an order release.
• shipUnitXid: string
  The XID for the ship unit associated to a order release.
• specialServices: specialServices
• tag1: string
  A flexible field to contain informational data that has been copied from the order to the shipment.
• tag2: string
  A flexible field to contain informational data that has been copied from the order to the shipment.
• tag3: string
  A flexible field to contain informational data that has been copied from the order to the shipment.
• tag4: string
  A flexible field to contain informational data that has been copied from the order to the shipment.
• texts: texts
• totalGrossVolume: totalGrossVolume
  The total gross volume of the order release ship unit (transport handling unit + lines).
• totalGrossWeight: totalGrossWeight
  The total gross weight of the order release ship unit (transport handling unit + lines).
• transportHandlingUnitGid: string
  The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
• unitDiameter: unitDiameter
  The unit diameter of the ship unit.
• unitHeight: unitHeight
  The height of each order release ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
• unitLength: unitLength
  The length of each order release ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
• unitNetVolume: unitNetVolume
  The net volume of the ship unit.
• unitNetWeight: unitNetWeight
  The net weight of the ship unit.
• unitVolume: unitVolume
  The volume of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.
• unitWeight: unitWeight
  The weight of the ship unit.
• unitWidth: unitWidth
  The width of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this order release ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.

{
    "properties":{
        "shipUnitGid":{
            "description":"The GID for the ship unit associated to an order release.",
            "type":"string"
        },
        "shipUnitXid":{
            "description":"The XID for the ship unit associated to a order release.",
            "type":"string"
        },
        "isSplitable":{
            "description":"A Y/N flag to identify if the ship unit can be split when creating an order.",
            "type":"boolean"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.",
            "type":"string"
        },
        "unitLength":{
            "description":"The length of each order release ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitWidth":{
            "description":"The width of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this order release ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitHeight":{
            "description":"The height of each order release ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitWeight":{
            "description":"The weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitVolume":{
            "description":"The volume of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "flexCommodityCode":{
            "description":"The user defined commodity code for the item. E.g.. the HTS, NMFC, SITC, STCC codes for the item.",
            "type":"string"
        },
        "flexCommodityQualGid":{
            "description":"A unique identifier to define the type of the code. E.g.. HTS, SITC, STCC, NMFC etc.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"A Y/N indicator to define if the record is generated by the system for the order base or copied (may be from XML).",
            "type":"boolean"
        },
        "orEquipmentSeq":{
            "description":"Associates equipment of the order release to this particular ship unit.",
            "type":"number",
            "format":"int32"
        },
        "shipUnitCount":{
            "description":"Ship units that have the same dimension/weight and contents are represented as one row in the SHIP_UNIT table. The ship unit count is the number of these ship units.",
            "type":"number",
            "format":"int64"
        },
        "obShipUnitGid":{
            "description":"The order base ship unit associated with the order release ship unit if it was created from an order base and the releasing logic.",
            "type":"string",
            "readOnly":true
        },
        "unitNetWeight":{
            "description":"The net weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitNetVolume":{
            "description":"The net volume of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondaryUnitWeight":{
            "description":"An additional value for the secondary gross weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondaryUnitVolume":{
            "description":"An additional value for the secondary gross volume of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondryUnitNetWt":{
            "description":"An additional value for the secondary net weight of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondryUnitNetVol":{
            "description":"An additional value for the secondary net volume of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitDiameter":{
            "description":"The unit diameter of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tag1":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag2":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag3":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "tag4":{
            "description":"A flexible field to contain informational data that has been copied from the order to the shipment.",
            "type":"string"
        },
        "obSuReleaseInstrSeq":{
            "description":"The release instruction associated to the order base if the order release was created from an order base through the releasing logic.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "isCountSplittable":{
            "description":"A Y/N indicator for whether the ship unit can be split on the count boundaries when planning during container optimization.",
            "type":"boolean"
        },
        "pickupOrStopGid":{
            "description":"This ship unit is going to be picked up at this stop. If this field is empty, this ship unit is picked up at the order's source location.",
            "type":"string"
        },
        "dropoffOrStopGid":{
            "description":"This ship unit is going to be dropped off at this stop. If this field is empty, this ship unit is dropped off at the order's destination location.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "totalGrossWeight":{
            "description":"The total gross weight of the order release ship unit (transport handling unit + lines).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalGrossVolume":{
            "description":"The total gross volume of the order release ship unit (transport handling unit + lines).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "loadConfigSetupGid":{
            "description":"A load configurator set up identifier to be used by the load configuration engine as the input rules for how the ship unit was built.",
            "type":"string"
        },
        "isAllowRepack":{
            "description":"A Y/N field, if this flag is set to false, when planning order movement that contains this shipment ship unit or combine shipments that contains this shipment ship unit, the shipment ship unit building process will not repack this s ship unit. ",
            "type":"boolean"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isExclusiveUse":{
            "description":"Used to specify if the ship unit is EXCLUSIVE USE. Ship unit is not mixed with anything even if they belong to the same MIXING family if its marked as EXCLUSIVE USE.",
            "type":"boolean"
        },
        "priority":{
            "description":"This column defines the priority associated with a ship unit.",
            "type":"number",
            "format":"int32"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "lines":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.lines"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "loadingSplits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.loadingSplits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : coreDiameter

For cylindrical objects, this defines the diameter of the core

Match All

For cylindrical objects, this defines the diameter of the core

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the core",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lines

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.lines"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : loadingSplits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.loadingSplits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryUnitVolume

An additional value for the secondary gross volume of the ship unit.

Match All

An additional value for the secondary gross volume of the ship unit.

Show Source

• object amountType

{
    "description":"An additional value for the secondary gross volume of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondaryUnitWeight

An additional value for the secondary gross weight of the ship unit.

Match All

An additional value for the secondary gross weight of the ship unit.

Show Source

• object amountType

{
    "description":"An additional value for the secondary gross weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondryUnitNetVol

An additional value for the secondary net volume of the ship unit.

Match All

An additional value for the secondary net volume of the ship unit.

Show Source

• object amountType

{
    "description":"An additional value for the secondary net volume of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondryUnitNetWt

An additional value for the secondary net weight of the ship unit.

Match All

An additional value for the secondary net weight of the ship unit.

Show Source

• object amountType

{
    "description":"An additional value for the secondary net weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : totalGrossVolume

The total gross volume of the order release ship unit (transport handling unit + lines).

Match All

The total gross volume of the order release ship unit (transport handling unit + lines).

Show Source

• object amountType

{
    "description":"The total gross volume of the order release ship unit (transport handling unit + lines).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalGrossWeight

The total gross weight of the order release ship unit (transport handling unit + lines).

Match All

The total gross weight of the order release ship unit (transport handling unit + lines).

Show Source

• object amountType

{
    "description":"The total gross weight of the order release ship unit (transport handling unit + lines).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitDiameter

The unit diameter of the ship unit.

Match All

The unit diameter of the ship unit.

Show Source

• object amountType

{
    "description":"The unit diameter of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitHeight

The height of each order release ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.

Match All

The height of each order release ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.

Show Source

• object amountType

{
    "description":"The height of each order release ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitLength

The length of each order release ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.

Match All

The length of each order release ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.

Show Source

• object amountType

{
    "description":"The length of each order release ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitNetVolume

The net volume of the ship unit.

Match All

The net volume of the ship unit.

Show Source

• object amountType

{
    "description":"The net volume of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitNetWeight

The net weight of the ship unit.

Match All

The net weight of the ship unit.

Show Source

• object amountType

{
    "description":"The net weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitVolume

The volume of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.

Match All

The volume of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.

Show Source

• object amountType

{
    "description":"The volume of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the volume of this shipment ship unit is computed as the total of container volume from its ship unit specification and the volume of its shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitWeight

The weight of the ship unit.

Match All

The weight of the ship unit.

Show Source

• object amountType

{
    "description":"The weight of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : unitWidth

The width of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this order release ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.

Match All

The width of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this order release ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.

Show Source

• object amountType

{
    "description":"The width of each order release ship unit. Each row may represent the ship unit count number of same ship units. If this field is null or is 0, the weight of this order release ship unit is computed as the total of container weight from its ship unit specification and the weight of its shipment ship unit lines.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.equipmentRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of equipment reference units this ship unit will consume when loading onto the equipment.
• totalNumReferenceUnits: number (double)
  The total equipment reference units max consumption demand for this ship unit.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The number of equipment reference units this ship unit will consume when loading onto the equipment.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "totalNumReferenceUnits":{
            "description":"The total equipment reference units max consumption demand for this ship unit.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.lines"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• countPerShipUnit: number (int64)
  The count per ship unit.
• domainName: string
  Database domain where this data is stored.
• itemPackageCount: number (int64)
  The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
• links: array links
  Read Only: true
• netVolume: netVolume
  The net volume of the item.
• netWeight: netWeight
  The net weight of the item.
• obLineGid: string
  Read Only: true

  The order base line associated with this ship unit line content line items if the order release was built from the order base.
• obLineReleaseInstrSeq: number (int64)
  Read Only: true

  The release instruction identifier from the order base line if the ship unit line was constructed through the order base releasing logic.
• orderReleaseLine: orderReleaseLine
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseLineGid: string
  The order release line associated with this ship unit line content line items. This attribute is marked as Create-Only.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item GID defining the line for the ship unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagingUnitCount: number (int64)
  The packaging unit count for the packaged unit that is being shipped.
• packagingUnitGid: string
  The GID for the packaging unit that is related to the shipment line.
• refnums: refnums
• remarks: remarks
• secondaryVolume: secondaryVolume
  As additional value for the secondary volume of the item.
• secondaryWeight: secondaryWeight
  An additional value for the secondary weight of the item.
• secondryNetVolume: secondryNetVolume
  As additional value for the net secondary volume of the item.
• secondryNetWeight: secondryNetWeight
  An additional value for the secondary net weight of the item.
• shipUnitLineNo: number (int32)
  The unique sequence within the ship unit to define the individual line items.
• volume: volume
  The gross volume of the item.
• volumePerShipUnit: volumePerShipUnit
  The weight per shipping line count to handle shipping a multiple count.
• weight: weight
  The gross weight of the item.
• weightPerShipUnit: weightPerShipUnit
  The weight per shipping line count to handle shipping a multiple count.

{
    "properties":{
        "shipUnitLineNo":{
            "description":"The unique sequence within the ship unit to define the individual line items.",
            "type":"number",
            "format":"int32"
        },
        "orderReleaseLineGid":{
            "description":"The order release line associated with this ship unit line content line items. This attribute is marked as Create-Only. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderReleaseLine":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleaseLines"
                }
            ],
            "readOnly":true
        },
        "weight":{
            "description":"The gross weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The gross volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "itemPackageCount":{
            "description":"The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.",
            "type":"number",
            "format":"int64"
        },
        "obLineGid":{
            "description":"The order base line associated with this ship unit line content line items if the order release was built from the order base.",
            "type":"string",
            "readOnly":true
        },
        "weightPerShipUnit":{
            "description":"The weight per shipping line count to handle shipping a multiple count.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volumePerShipUnit":{
            "description":"The weight per shipping line count to handle shipping a multiple count.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "countPerShipUnit":{
            "description":"The count per ship unit.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit that is related to the shipment line.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count for the packaged unit that is being shipped.",
            "type":"number",
            "format":"int64"
        },
        "secondaryWeight":{
            "description":"An additional value for the secondary weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondaryVolume":{
            "description":"As additional value for the secondary volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "netWeight":{
            "description":"The net weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "netVolume":{
            "description":"The net volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondryNetWeight":{
            "description":"An additional value for the secondary net weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "secondryNetVolume":{
            "description":"As additional value for the net secondary volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "obLineReleaseInstrSeq":{
            "description":"The release instruction identifier from the order base line if the ship unit line was constructed through the order base releasing logic.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "packagedItemGid":{
            "description":"The packaged item GID defining the line for the ship unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.lines.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.shipUnits.lines.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : netVolume

The net volume of the item.

Match All

The net volume of the item.

Show Source

• object amountType

{
    "description":"The net volume of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : netWeight

The net weight of the item.

Match All

The net weight of the item.

Show Source

• object amountType

{
    "description":"The net weight of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : orderReleaseLine

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object orderReleaseLines

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleaseLines"
        }
    ],
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.lines.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.shipUnits.lines.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryVolume

As additional value for the secondary volume of the item.

Match All

As additional value for the secondary volume of the item.

Show Source

• object amountType

{
    "description":"As additional value for the secondary volume of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondaryWeight

An additional value for the secondary weight of the item.

Match All

An additional value for the secondary weight of the item.

Show Source

• object amountType

{
    "description":"An additional value for the secondary weight of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondryNetVolume

As additional value for the net secondary volume of the item.

Match All

As additional value for the net secondary volume of the item.

Show Source

• object amountType

{
    "description":"As additional value for the net secondary volume of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : secondryNetWeight

An additional value for the secondary net weight of the item.

Match All

An additional value for the secondary net weight of the item.

Show Source

• object amountType

{
    "description":"An additional value for the secondary net weight of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volume

The gross volume of the item.

Match All

The gross volume of the item.

Show Source

• object amountType

{
    "description":"The gross volume of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volumePerShipUnit

The weight per shipping line count to handle shipping a multiple count.

Match All

The weight per shipping line count to handle shipping a multiple count.

Show Source

• object amountType

{
    "description":"The weight per shipping line count to handle shipping a multiple count.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The gross weight of the item.

Match All

The gross weight of the item.

Show Source

• object amountType

{
    "description":"The gross weight of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weightPerShipUnit

The weight per shipping line count to handle shipping a multiple count.

Match All

The weight per shipping line count to handle shipping a multiple count.

Show Source

• object amountType

{
    "description":"The weight per shipping line count to handle shipping a multiple count.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.lines.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipUnitRefnumQualGid: string
  The reference number qualifier GID defining the reference code.
• shipUnitRefnumValue: string
  The text associated to the reference code.

{
    "properties":{
        "shipUnitRefnumQualGid":{
            "description":"The reference number qualifier GID defining the reference code.",
            "type":"string"
        },
        "shipUnitRefnumValue":{
            "description":"The text associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.lines.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the order release.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the order release.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.loadingSplits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• height: height
  The height for the this part of the ship unit split.
• length: length
  The length for the this part of the ship unit split.
• links: array links
  Read Only: true
• splitNo: number (int32)
  The split number for the ship unit.
• volume: volume
  The volume for the this part of the ship unit split.
• weight: weight
  The weight for the this part of the ship unit split.
• width: width
  The width for the this part of the ship unit split.

{
    "properties":{
        "splitNo":{
            "description":"The split number for the ship unit.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "length":{
            "description":"The length for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"The weight for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : height

The height for the this part of the ship unit split.

Match All

The height for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The height for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

The length for the this part of the ship unit split.

Match All

The length for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The length for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : volume

The volume for the this part of the ship unit split.

Match All

The volume for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The volume for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight for the this part of the ship unit split.

Match All

The weight for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The weight for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width for the this part of the ship unit split.

Match All

The width for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The width for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipUnitRefnumQualGid: string
  The reference number qualifier identifier defining the reference code.
• shipUnitRefnumValue: string
  The text associated to the reference number code.

{
    "properties":{
        "shipUnitRefnumQualGid":{
            "description":"The reference number qualifier identifier defining the reference code.",
            "type":"string"
        },
        "shipUnitRefnumValue":{
            "description":"The text associated to the reference number code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the order release.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the order release.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipUnitSealNum: string
  The ship unit seal number for the order release ship unit.

{
    "properties":{
        "shipUnitSealNum":{
            "description":"The ship unit seal number for the order release ship unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  The special service associated with the remark.
• links: array links
  Read Only: true
• specialServiceGid: string
  The special service identifier defining the special service that needs to be performed for the ship unit.

{
    "properties":{
        "specialServiceGid":{
            "description":"The special service identifier defining the special service that needs to be performed for the ship unit.",
            "type":"string"
        },
        "domainName":{
            "description":"The special service associated with the remark.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.shipUnits.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  Document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for the text template. A text template is a predefined, formatted selection of text that is identified by a business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template. A text template is a predefined, formatted selection of text that is identified by a business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• forSourceDest: string
  Define if this special service is required for source and/or destination location of this order.
• links: array links
  Read Only: true
• specialServiceCodeGid: string
  The special service code GID defining the service required.
• time: time
  The duration required for the special service.

{
    "properties":{
        "specialServiceCodeGid":{
            "description":"The special service code GID defining the service required.",
            "type":"string"
        },
        "time":{
            "description":"The duration required for the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "forSourceDest":{
            "description":"Define if this special service is required for source and/or destination location of this order.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : time

The duration required for the special service.

Match All

The duration required for the special service.

Show Source

• object amountType

{
    "description":"The duration required for the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type GID for the status value on the order release.
• statusValueGid: string
  The status value for the order release status.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type GID for the status value on the order release.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the order release status.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.stops"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• earlyArrivalTime: earlyArrivalTime
  The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.
• isAppt: boolean
  A Y/N field indicating that the times are for appointments, when IS_APPT is Y, EARLY/LATE_ARRIVAL_TIME are appointment times.
• isApptConfirmed: boolean
  A Y/N field to indicate the appointment is confirmed.
• isApptConfirmRequired: boolean
  A Y/N field to indicate if appointment confirmation is required.
• isApptRequired: boolean
  A Y/N field to indicate if appointment is required.
• lateArrivalTime: lateArrivalTime
  The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.
• legPosition: string
  Define where to insert this stop in a multi-stop situation.
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  The location GID for the shipment stop.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• orStopGid: string
  The GID for the stop associated to the order release for multi-stop orders.
• orStopSeq: number (int32)
  The stop number within the order release. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.
• orStopXid: string
  The XID for the stop associated to the order release for multi-stop orders.
• remarks: remarks
• specialServices: specialServices

{
    "properties":{
        "orStopGid":{
            "description":"The GID for the stop associated to the order release for multi-stop orders.",
            "type":"string"
        },
        "orStopXid":{
            "description":"The XID for the stop associated to the order release for multi-stop orders.",
            "type":"string"
        },
        "orStopSeq":{
            "description":"The stop number within the order release. Stop number = 1 is the pickup stop, and the max (stop number) for a shipment is the delivery stop.",
            "type":"number",
            "format":"int32"
        },
        "locationGid":{
            "description":"The location GID for the shipment stop. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "earlyArrivalTime":{
            "description":"The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lateArrivalTime":{
            "description":"The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isAppt":{
            "description":"A Y/N field indicating that the times are for appointments, when IS_APPT is Y, EARLY/LATE_ARRIVAL_TIME are appointment times.",
            "type":"boolean"
        },
        "isApptRequired":{
            "description":"A Y/N field to indicate if appointment is required.",
            "type":"boolean"
        },
        "isApptConfirmRequired":{
            "description":"A Y/N field to indicate if appointment confirmation is required.",
            "type":"boolean"
        },
        "isApptConfirmed":{
            "description":"A Y/N field to indicate the appointment is confirmed.",
            "type":"boolean"
        },
        "legPosition":{
            "description":"Define where to insert this stop in a multi-stop situation.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.stops.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderReleases.stops.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : earlyArrivalTime

The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.

Match All

The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.

Show Source

• object dateTimeType

{
    "description":"The arrival date and time for the stop, and when IS_APPT is Y, this field is early appointment time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lateArrivalTime

The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.

Match All

The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.

Show Source

• object dateTimeType

{
    "description":"The late arrival date and time for the stop, and when IS_APPT is Y, this field is late appointment time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.stops.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderReleases.stops.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.stops.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.
• remarkSequence: number (int64)
  The sequence (key) for the remark.
• remarkText: string
  A user-entered remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence (key) for the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: Service provider assigned equipment number, service provider tender decline reason code, etc.",
            "type":"string"
        },
        "remarkText":{
            "description":"A user-entered remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.stops.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The special service code identifier defining the service required.
• time: time
  The duration required for the special service at the stop.

{
    "properties":{
        "specialServiceGid":{
            "description":"The special service code identifier defining the service required.",
            "type":"string"
        },
        "time":{
            "description":"The duration required for the special service at the stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : time

The duration required for the special service at the stop.

Match All

The duration required for the special service at the stop.

Show Source

• object amountType

{
    "description":"The duration required for the special service at the stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentDefGid: string
  A document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The foreign key to the text template table, in order to include fixed text with this order release.

{
    "properties":{
        "textTemplateGid":{
            "description":"The foreign key to the text template table, in order to include fixed text with this order release.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"A document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderReleases.trackingEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.trackingEvents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderReleases.trackingEvents

Type: object

Show Source

• bsContactFunctionCode: string
  This indicates the shipment stop number for a stop based event.
• bsContactName: string
  The reporting method that links into the communication methods defined for OTM.
• bsReasonCodeGid: string
  The reason code from the tracking event that was matched to the order releases.
• bsResponsiblePartyGid: string
  The responsible party identifier of the source of the tracking event.
• bsStatusCodeGid: string
  A Y/N indicator to display the status history.
• description: string
  A description of the tracking event.
• domainName: string
  Database domain where this data is stored.
• eventDate: eventDate
  The location identifier of an location based event. This will be null for non-location based events.
• iTransactionNo: number (int64)
  The transaction identifier for the order release data of the tracking event.
• links: array links
  Read Only: true
• orderReleaseRefnumQualGid: string
  The order release reference number qualifier identifier.
• orderReleaseRefnumValue: string
  The order release reference number value associated with the order release qualifier that came on the tracking event.
• reportingGluser: string
  The service provider associated with generating the tracking event.
• statusLevel: string
  A descriptor code for the status level of the tracking event.
• timeZoneGid: string
  The monthly range partition to manage purging status messages.

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier for the order release data of the tracking event.",
            "type":"number",
            "format":"int64"
        },
        "reportingGluser":{
            "description":"The service provider associated with generating the tracking event.",
            "type":"string"
        },
        "bsContactName":{
            "description":"The reporting method that links into the communication methods defined for OTM.",
            "type":"string"
        },
        "bsContactFunctionCode":{
            "description":"This indicates the shipment stop number for a stop based event.",
            "type":"string"
        },
        "eventDate":{
            "description":"The location identifier of an location based event. This will be null for non-location based events.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "bsStatusCodeGid":{
            "description":"A Y/N indicator to display the status history.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The monthly range partition to manage purging status messages.",
            "type":"string"
        },
        "statusLevel":{
            "description":"A descriptor code for the status level of the tracking event.",
            "type":"string"
        },
        "description":{
            "description":"A description of the tracking event.",
            "type":"string"
        },
        "orderReleaseRefnumValue":{
            "description":"The order release reference number value associated with the order release qualifier that came on the tracking event.",
            "type":"string"
        },
        "orderReleaseRefnumQualGid":{
            "description":"The order release reference number qualifier identifier.",
            "type":"string"
        },
        "bsReasonCodeGid":{
            "description":"The reason code from the tracking event that was matched to the order releases.",
            "type":"string"
        },
        "bsResponsiblePartyGid":{
            "description":"The responsible party identifier of the source of the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventDate

The location identifier of an location based event. This will be null for non-location based events.

Match All

The location identifier of an location based event. This will be null for non-location based events.

Show Source

• object dateTimeType

{
    "description":"The location identifier of an location based event. This will be null for non-location based events.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.allocations.orderBaseLineAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.allocations.orderBaseLineAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.allocations.orderBaseLineAllocations

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  No description.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  No description.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• obLineGid: string
  No description.
• shipmentCostSeqno: number (int64)
  No description.
• shipmentGid: string
  No description.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  No description.

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "obLineGid":{
            "description":"No description.",
            "type":"string"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"No description.",
            "type":"string"
        },
        "voucherGid":{
            "description":"No description.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.allocations.orderLineAllocations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.allocations.orderLineAllocations"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.allocations.orderLineAllocations

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  cost type for this allocation record
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  GL code for the allocation order release line record.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• orderReleaseLine: orderReleaseLine
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseLineGid: string
  No description.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipmentCostSeqno: number (int64)
  Shipment cost seq no would be stored if we perform allocation based on shipment
• shipmentGid: string
  Shipment Gid would be stored in this field if allocation is done based Shipment.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  Voucher Gid would be stored in this field if allocation is done based on voucher or invoice

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseLineGid":{
            "description":"No description. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderReleaseLine":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleaseLines"
                }
            ],
            "readOnly":true
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "generalLedgerGid":{
            "description":"GL code for the allocation order release line record.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"cost type for this allocation record",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"Shipment cost seq no would be stored if we perform allocation based on shipment",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"Shipment  Gid would be stored in this field if allocation is done based Shipment.",
            "type":"string"
        },
        "voucherGid":{
            "description":"Voucher  Gid would be stored in this field if allocation is done based on voucher or invoice",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderReleaseLine

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object orderReleaseLines

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseLineGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleaseLines"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object documents

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.equipmentDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.equipmentDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.equipmentDetails

Type: object

Show Source

• descriptionCode: string
  Description code.
• domainName: string
  Database domain where this data is stored.
• dunnage: dunnage
  Dunnage.
• equipmentInitialNumber: string
  The Equipment Initial/Number field is a concatenation of equipment initial and equipment number. The initial is a mark that is registered with national or international authorities that is associated with a specific owner.
• equipmentNumber: string
  The number for the equipment.
• equipmentOwnerIdentifier: string
  The identifier of the equipment owner.
• equipmentPrefix: string
  The prefix of the equipment that was used for the shipment that relates to this invoice.
• height: height
  The height of the equipment.
• isoEquipmentTypeIdentifier: string
  The ISO equipment type identifier.
• length: length
  The length of the equipment.
• links: array links
  Read Only: true
• maximumTemperature: maximumTemperature
  The maximum temperature for the equipment.
• minimumTemperature: minimumTemperature
  The minimum temperature for the equipment.
• ownershipCode: string
  Ownership code.
• percentHumidityAllowed: number (int32)
  The maximum percentage of humidity allowed for the equipment.
• seals: seals
• seqNumber: number (int64)
  Internal database sequence number related to each invoice equipment entry.
• sEquipment: sEquipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sEquipmentGid: string
  The GID for the shipment equipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• tareWeight: tareWeight
  Weight of equipment when empty.
• unitCount: number (int64)
  Unit count.
• ventSettingCode: string
  The vent setting code.
• volume: volume
  The volume of the equipment.
• weight: weight
  The weight of the equipment.
• weightAllowance: weightAllowance
  The regulatory maximum weight for the equipment.
• weightQualifier: string
  Weight qualifier.
• width: width
  The width of the equipment.

{
    "properties":{
        "seqNumber":{
            "description":"Internal database sequence number related to each invoice equipment entry.",
            "type":"number",
            "format":"int64"
        },
        "equipmentInitialNumber":{
            "description":"The Equipment Initial/Number field is a concatenation of equipment initial and equipment number. The initial is a mark that is registered with national or international authorities that is associated with a specific owner.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The GID for the shipment equipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sEquipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sEquipments"
                }
            ],
            "readOnly":true
        },
        "equipmentPrefix":{
            "description":"The prefix of the equipment that was used for the shipment that relates to this invoice.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The number for the equipment.",
            "type":"string"
        },
        "isoEquipmentTypeIdentifier":{
            "description":"The ISO equipment type identifier.",
            "type":"string"
        },
        "descriptionCode":{
            "description":"Description code.",
            "type":"string"
        },
        "equipmentOwnerIdentifier":{
            "description":"The identifier of the equipment owner.",
            "type":"string"
        },
        "ownershipCode":{
            "description":"Ownership code.",
            "type":"string"
        },
        "length":{
            "description":"The length of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"The weight of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"Weight of equipment when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "dunnage":{
            "description":"Dunnage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "minimumTemperature":{
            "description":"The minimum temperature for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maximumTemperature":{
            "description":"The maximum temperature for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "percentHumidityAllowed":{
            "description":"The maximum percentage of humidity allowed for the equipment.",
            "type":"number",
            "format":"int32"
        },
        "ventSettingCode":{
            "description":"The vent setting code.",
            "type":"string"
        },
        "weightAllowance":{
            "description":"The regulatory maximum weight for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.equipmentDetails.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : dunnage

Dunnage.

Match All

Dunnage.

Show Source

• object amountType

{
    "description":"Dunnage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : height

The height of the equipment.

Match All

The height of the equipment.

Show Source

• object amountType

{
    "description":"The height of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

The length of the equipment.

Match All

The length of the equipment.

Show Source

• object amountType

{
    "description":"The length of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maximumTemperature

The maximum temperature for the equipment.

Match All

The maximum temperature for the equipment.

Show Source

• object amountType

{
    "description":"The maximum temperature for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minimumTemperature

The minimum temperature for the equipment.

Match All

The minimum temperature for the equipment.

Show Source

• object amountType

{
    "description":"The minimum temperature for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.equipmentDetails.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sEquipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object sEquipments

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sEquipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sEquipments"
        }
    ],
    "readOnly":true
}

Nested Schema : tareWeight

Weight of equipment when empty.

Match All

Weight of equipment when empty.

Show Source

• object amountType

{
    "description":"Weight of equipment when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volume

The volume of the equipment.

Match All

The volume of the equipment.

Show Source

• object amountType

{
    "description":"The volume of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight of the equipment.

Match All

The weight of the equipment.

Show Source

• object amountType

{
    "description":"The weight of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weightAllowance

The regulatory maximum weight for the equipment.

Match All

The regulatory maximum weight for the equipment.

Show Source

• object amountType

{
    "description":"The regulatory maximum weight for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width of the equipment.

Match All

The width of the equipment.

Show Source

• object amountType

{
    "description":"The width of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.equipmentDetails.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.equipmentDetails.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.equipmentDetails.seals

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• sealNumber: string
  The identification number for equipment that has been sealed.
• sealSequence: number (int32)
  Seal sequence number.

{
    "properties":{
        "sealSequence":{
            "description":"Seal sequence number.",
            "type":"number",
            "format":"int32"
        },
        "sealNumber":{
            "description":"The identification number for equipment that has been sealed.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method GID.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The involved party contact GID.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The GID for an involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for an involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The involved party contact GID. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.lineItems

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.lineItems"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.lineItems

Type: object

Show Source

• accessorialCodeGid: string
  The GID for an accessorial code.
• accessorialDescription: string
  Text to describe the accessorial.
• adjustmentReasonCodeGid: string
  The GID for the adjustment reason code used to specify why an adjustment was made to the line.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency2: attributeCurrency2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency3: attributeCurrency3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• billableIndicatorGid: string
  The indicator used to tell if this line item is billable (sell side bill only).
• billedAsQualifier: string
  Qualifier for Billed as quantity.
• billedAsQuantity: number (double)
  Billed as quantity.
• commercialData: commercialData
• compartmentIdCode: string
  The identification number for the equipment's compartment for this line item.
• costRefs: costRefs
• costTypeGid: string
  The cost type for the invoice line.
• declaredValue: declaredValue
  The stated value of this line item.
• declaredValueQualGid: string
  The declared value qualifier GID.
• description: string
  Text describing the line item on the invoice.
• deviationAmount: deviationAmount
  The actual deviation in the tolerance amount based upon rule.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
• exportLicControlCode: string
  Export license control code.
• exportLicCountryCode3Gid: string
  The export license country code GID.
• exportLicExpDate: exportLicExpDate
  The date on which the export license expires.
• exportLicNumber: string
  The identification number for the export license.
• flexCommodityCode: string
  Flex commodity code.
• flexCommodityQualGid: string
  The flexible commodity qualifier GID.
• freightCharge: freightCharge
  The freight charge for this line item.
• freightRateQualifier: string
  The qualifier for the freight rate.
• freightRateValue: freightRateValue
  Freight rate value.
• generalLedgerGid: string
  GL code for the invoice line item.
• importLicExpDate: importLicExpDate
  The expiration date for the import license.
• importLicIssueDate: importLicIssueDate
  The issue date for the import license.
• importLicNumber: string
  The import license number.
• indicator: string
  The invoice line item indicator.
• lineitemSeqNo: number (int32)
  Line item sequence number.
• links: array links
  Read Only: true
• marks: string
  Marks.
• marksQualifier: string
  Qualifier for Marks.
• matchStatus: string
  Invoice line item status. UNMATCHED: It means the invoice line item has not been matched to any shipment cost. MATCHED: It means the invoice line item has been matched to shipment cost. MATCHED_IN_TOLERANCE: It means the invoice line item has been matched to shipment cost and passed the line level tolerance check. MATCHED_OUT_OF_TOLERANCE: It means the invoice line item has been matched to shipment cost and failed the line level tolerance check. UNMATCHED_IN_TOLERANCE: It means the invoice line item has not been matched to any shipment cost and it is within the tolerance limit. UNMATCHED_OUT_OF_TOLERANCE: It means the invoice line item has not been matched to any shipment cost and failed the line level tolerance check.
• outOfTolAmt: outOfTolAmt
  The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.
• outOfTolReasonCodeGid: string
  The GID for the out of tolerance amount reason code.
• paymentMethodCodeGid: string
  The GID for the method of payment for the invoice. Examples of payment include cash on delivery, check and electronic funds transfer.
• prepaidAmount: prepaidAmount
  The amount that was already collected towards this invoice line item.
• processAsFlowThru: boolean
  Flag to identify this cost was processed as a flow thru and needs to be considered during adjustments.
• refnums: refnums
• remarks: remarks
• tariffAgencyCode: string
  The code for the tariff agency.
• tariffEffectiveDate: tariffEffectiveDate
  The effective date of the tariff.
• tariffFreightClassCode: string
  The code for the tariff freight class.
• tariffIssuingCarrierId: string
  The identification number for the carrier that issued the tariff.
• tariffItemNumber: string
  Tariff item number.
• tariffItemNumberSuffix: string
  Tariff item number suffix.
• tariffItemPart: string
  Tariff item part.
• tariffPubAuthority: string
  Tariff Pub Authority.
• tariffRefnum: string
  Tariff reference number.
• tariffRefnumQualifier: string
  Tariff reference number qualifier.
• tariffRefnumSuffix: string
  Suffix for the tariff reference number.
• tariffRegAgencyCode: string
  Tariff Reg Agency.
• tariffSection: string
  Tariff section.
• tariffSupplementId: string
  Tariff supplement ID.
• transportHandlingUnitGid: string
  The GID for the transport handling unit associated with the invoice line item.
• unitCount: number (int64)
  Unit count for that line.
• vatCodeGid: string
  Used by the invoice action to manually calculate VAT. This field is intended to be user entered (via UI or integration) so that a VAT code may be applied to an entire invoice line item easily without the user having to specify invoice line item VAT records. The system does not populate this field.
• vats: vats
• volume: volume
  Total volume for line item.
• vouchers: vouchers
• weight: weight
  Total weight for line item.
• weightQualifier: string
  Weight qualifier.

{
    "properties":{
        "lineitemSeqNo":{
            "description":"Line item sequence number.",
            "type":"number",
            "format":"int32"
        },
        "description":{
            "description":"Text describing the line item on the invoice.",
            "type":"string"
        },
        "unitCount":{
            "description":"Unit count for that line.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit associated with the invoice line item.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"The indicator used to tell if this line item is billable (sell side bill only).",
            "type":"string"
        },
        "flexCommodityQualGid":{
            "description":"The flexible commodity qualifier GID.",
            "type":"string"
        },
        "flexCommodityCode":{
            "description":"Flex commodity code.",
            "type":"string"
        },
        "weight":{
            "description":"Total weight for line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Total volume for line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "marks":{
            "description":"Marks.",
            "type":"string"
        },
        "marksQualifier":{
            "description":"Qualifier for Marks.",
            "type":"string"
        },
        "billedAsQualifier":{
            "description":"Qualifier for Billed as quantity.",
            "type":"string"
        },
        "billedAsQuantity":{
            "description":"Billed as quantity.",
            "type":"number",
            "format":"double"
        },
        "freightRateQualifier":{
            "description":"The qualifier for the freight rate.",
            "type":"string"
        },
        "freightRateValue":{
            "description":"Freight rate value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "freightCharge":{
            "description":"The freight charge for this line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "prepaidAmount":{
            "description":"The amount that was already collected towards this invoice line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "paymentMethodCodeGid":{
            "description":"The GID for the method of payment for the invoice. Examples of payment include cash on delivery, check and electronic funds transfer.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for an accessorial code.",
            "type":"string"
        },
        "accessorialDescription":{
            "description":"Text to describe the accessorial.",
            "type":"string"
        },
        "compartmentIdCode":{
            "description":"The identification number for the equipment's compartment for this line item.",
            "type":"string"
        },
        "exportLicControlCode":{
            "description":"Export license control code.",
            "type":"string"
        },
        "exportLicCountryCode3Gid":{
            "description":"The export license country code GID.",
            "type":"string"
        },
        "exportLicExpDate":{
            "description":"The date on which the export license expires.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exportLicNumber":{
            "description":"The identification number for the export license.",
            "type":"string"
        },
        "importLicExpDate":{
            "description":"The expiration date for the import license.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "importLicIssueDate":{
            "description":"The issue date for the import license.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "importLicNumber":{
            "description":"The import license number.",
            "type":"string"
        },
        "tariffAgencyCode":{
            "description":"The code for the tariff agency.",
            "type":"string"
        },
        "tariffRefnum":{
            "description":"Tariff reference number.",
            "type":"string"
        },
        "tariffRefnumQualifier":{
            "description":"Tariff reference number qualifier.",
            "type":"string"
        },
        "tariffRefnumSuffix":{
            "description":"Suffix for the tariff reference number.",
            "type":"string"
        },
        "tariffSection":{
            "description":"Tariff section.",
            "type":"string"
        },
        "tariffItemNumber":{
            "description":"Tariff item number.",
            "type":"string"
        },
        "tariffItemNumberSuffix":{
            "description":"Tariff item number suffix.",
            "type":"string"
        },
        "tariffItemPart":{
            "description":"Tariff item part.",
            "type":"string"
        },
        "tariffSupplementId":{
            "description":"Tariff supplement ID.",
            "type":"string"
        },
        "tariffRegAgencyCode":{
            "description":"Tariff Reg Agency.",
            "type":"string"
        },
        "tariffPubAuthority":{
            "description":"Tariff Pub Authority.",
            "type":"string"
        },
        "tariffIssuingCarrierId":{
            "description":"The identification number for the carrier that issued the tariff.",
            "type":"string"
        },
        "tariffFreightClassCode":{
            "description":"The code for the tariff freight class.",
            "type":"string"
        },
        "tariffEffectiveDate":{
            "description":"The effective date of the tariff.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "declaredValueQualGid":{
            "description":"The declared value qualifier GID.",
            "type":"string"
        },
        "declaredValue":{
            "description":"The stated value of this line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "adjustmentReasonCodeGid":{
            "description":"The GID for the adjustment reason code used to specify why an adjustment was made to the line.",
            "type":"string"
        },
        "processAsFlowThru":{
            "description":"Flag to identify this cost was processed as a flow thru and needs to be considered during adjustments.",
            "type":"boolean"
        },
        "generalLedgerGid":{
            "description":"GL code for the invoice line item.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "vatCodeGid":{
            "description":"Used by the invoice action to manually calculate VAT. This field is intended to be user entered (via UI or integration) so that a VAT code may be applied to an entire invoice line item easily without the user having to specify invoice line item VAT records. The system does not populate this field.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"The cost type for the invoice line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "indicator":{
            "description":"The invoice line item indicator.",
            "type":"string"
        },
        "outOfTolAmt":{
            "description":"The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "outOfTolReasonCodeGid":{
            "description":"The GID for the out of tolerance amount reason code.",
            "type":"string"
        },
        "deviationAmount":{
            "description":"The actual deviation in the tolerance amount based upon rule.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "matchStatus":{
            "description":"Invoice line item status. UNMATCHED: It means the invoice line item has not been matched to any shipment cost. MATCHED: It means the invoice line item has been matched to shipment cost. MATCHED_IN_TOLERANCE: It means the invoice line item has been matched to shipment cost and passed the line level tolerance check. MATCHED_OUT_OF_TOLERANCE: It means the invoice line item has been matched to shipment cost and failed the line level tolerance check. UNMATCHED_IN_TOLERANCE: It means the invoice line item has not been matched to any shipment cost and it is within the tolerance limit. UNMATCHED_OUT_OF_TOLERANCE: It means the invoice line item has not been matched to any shipment cost and failed the line level tolerance check. ",
            "type":"string"
        },
        "vats":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.lineItems.vats"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costRefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.lineItems.costRefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.lineItems.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "commercialData":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.lineItems.commercialData"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.lineItems.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vouchers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.lineItems.vouchers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : commercialData

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.lineItems.commercialData"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costRefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.lineItems.costRefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

The stated value of this line item.

Match All

The stated value of this line item.

Show Source

• object currencyType

{
    "description":"The stated value of this line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : deviationAmount

The actual deviation in the tolerance amount based upon rule.

Match All

The actual deviation in the tolerance amount based upon rule.

Show Source

• object currencyType

{
    "description":"The actual deviation in the tolerance amount based upon rule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : exportLicExpDate

The date on which the export license expires.

Match All

The date on which the export license expires.

Show Source

• object dateType

{
    "description":"The date on which the export license expires.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : freightCharge

The freight charge for this line item.

Match All

The freight charge for this line item.

Show Source

• object currencyType

{
    "description":"The freight charge for this line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : freightRateValue

Freight rate value.

Match All

Freight rate value.

Show Source

• object currencyType

{
    "description":"Freight rate value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : importLicExpDate

The expiration date for the import license.

Match All

The expiration date for the import license.

Show Source

• object dateType

{
    "description":"The expiration date for the import license.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : importLicIssueDate

The issue date for the import license.

Match All

The issue date for the import license.

Show Source

• object dateType

{
    "description":"The issue date for the import license.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : outOfTolAmt

The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.

Match All

The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.

Show Source

• object currencyType

{
    "description":"The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : prepaidAmount

The amount that was already collected towards this invoice line item.

Match All

The amount that was already collected towards this invoice line item.

Show Source

• object currencyType

{
    "description":"The amount that was already collected towards this invoice line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.lineItems.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.lineItems.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tariffEffectiveDate

The effective date of the tariff.

Match All

The effective date of the tariff.

Show Source

• object dateType

{
    "description":"The effective date of the tariff.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : vats

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.lineItems.vats"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

Total volume for line item.

Match All

Total volume for line item.

Show Source

• object amountType

{
    "description":"Total volume for line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : vouchers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.lineItems.vouchers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : weight

Total weight for line item.

Match All

Total weight for line item.

Show Source

• object amountType

{
    "description":"Total weight for line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.lineItems.commercialData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.lineItems.commercialData"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.lineItems.commercialData

Type: object

Show Source

• commercialDataSeqNo: number (int32)
  Sequence number for the commercial data line.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
• links: array links
  Read Only: true
• liTotalCommercialValue: liTotalCommercialValue
  Line item total commercial value.
• packagingUnitGid: string
  The GID for the packaging unit.
• unitCount: number (int64)
  Unit count.
• unitPrice: unitPrice
  The price for the units being shipped.
• unitPriceQualifier: string
  Qualifier for the unit price.

{
    "properties":{
        "commercialDataSeqNo":{
            "description":"Sequence number for the commercial data line.",
            "type":"number",
            "format":"int32"
        },
        "unitPrice":{
            "description":"The price for the units being shipped.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitPriceQualifier":{
            "description":"Qualifier for the unit price.",
            "type":"string"
        },
        "liTotalCommercialValue":{
            "description":"Line item total commercial value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : liTotalCommercialValue

Line item total commercial value.

Match All

Line item total commercial value.

Show Source

• object currencyType

{
    "description":"Line item total commercial value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : unitPrice

The price for the units being shipped.

Match All

The price for the units being shipped.

Show Source

• object currencyType

{
    "description":"The price for the units being shipped.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.lineItems.costRefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.lineItems.costRefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.lineItems.costRefs

Type: object

Show Source

• costReferenceGid: string
  The GID for the cost reference.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentCostQualGid: string
  The GID for the shipment cost qualifier.

{
    "properties":{
        "costReferenceGid":{
            "description":"The GID for the cost reference.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The GID for the shipment cost qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.lineItems.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.lineItems.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.lineItems.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• invoiceLiRefnumQualGid: string
  The invoice line item reference number qualifier GID.
• links: array links
  Read Only: true
• referenceNumber: string
  Line item reference number.

{
    "properties":{
        "invoiceLiRefnumQualGid":{
            "description":"The invoice line item reference number qualifier GID.",
            "type":"string"
        },
        "referenceNumber":{
            "description":"Line item reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.lineItems.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.lineItems.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.lineItems.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualIdentifier: string
  Remark qualifier.
• remarkSeqNo: number (int64)
  The sequence number for the line item remark on the invoice.
• remarkText: string
  Remarks about the line item on the invoice.

{
    "properties":{
        "remarkSeqNo":{
            "description":"The sequence number for the line item remark on the invoice.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualIdentifier":{
            "description":"Remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remarks about the line item on the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.lineItems.vats

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.lineItems.vats"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.lineItems.vats

Type: object

Show Source

• costRefs: costRefs
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• isCumulative: boolean
  If 'Y', the amount of this tax is based on the base cost plus the previously-calculated taxes.
• links: array links
  Read Only: true
• vatAmount: vatAmount
  This is the actual VAT amount.
• vatCalcAmt: vatCalcAmt
  This is the VAT amount calculated from the rate and base value.
• vatCodeGid: string
  The GID for the VAT tax that is being applied to the line item.
• vatCountryCode3Gid: string
  Country for which this VAT item applies
• vatOverrideAmt: vatOverrideAmt
  This is a manually entered amount to set the VAT regardless of rate.
• vatProvinceCode: string
  Province for which this VAT item applies (used for Canada).
• vatRate: number (double)
  The VAT charge rate.
• vatSeqno: number (int32)
  The VAT Sequence number is used when more than one VAT is applicable to the line item. This field tells the system what order to charge the taxes in.

{
    "properties":{
        "vatSeqno":{
            "description":"The VAT Sequence number is used when more than one VAT is applicable to the line item. This field tells the system what order to charge the taxes in.",
            "type":"number",
            "format":"int32"
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being applied to the line item.",
            "type":"string"
        },
        "vatCountryCode3Gid":{
            "description":"Country for which this VAT item applies",
            "type":"string"
        },
        "vatProvinceCode":{
            "description":"Province for which this VAT item applies (used for Canada).",
            "type":"string"
        },
        "vatRate":{
            "description":"The VAT charge rate.",
            "type":"number",
            "format":"double"
        },
        "vatAmount":{
            "description":"This is the actual VAT amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCalcAmt":{
            "description":"This is the VAT amount calculated from the rate and base value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatOverrideAmt":{
            "description":"This is a manually entered amount to set the VAT regardless of rate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isCumulative":{
            "description":"If 'Y', the amount of this tax is based on the base cost plus the previously-calculated taxes.",
            "type":"boolean"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costRefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.lineItems.vats.costRefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costRefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.lineItems.vats.costRefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vatAmount

This is the actual VAT amount.

Match All

This is the actual VAT amount.

Show Source

• object currencyType

{
    "description":"This is the actual VAT amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : vatCalcAmt

This is the VAT amount calculated from the rate and base value.

Match All

This is the VAT amount calculated from the rate and base value.

Show Source

• object currencyType

{
    "description":"This is the VAT amount calculated from the rate and base value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : vatOverrideAmt

This is a manually entered amount to set the VAT regardless of rate.

Match All

This is a manually entered amount to set the VAT regardless of rate.

Show Source

• object currencyType

{
    "description":"This is a manually entered amount to set the VAT regardless of rate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.lineItems.vats.costRefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.lineItems.vats.costRefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.lineItems.vats.costRefs

Type: object

Show Source

• costReferenceGid: string
  The GID for the cost reference.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentCostQualGid: string
  The GID for the shipment cost reference.
• vatAmount: vatAmount
  Monetary value of VAT for this cost reference item.
• vatBasisAmount: vatBasisAmount
  Allocated basis on which VAT is calculated for this cost reference item.

{
    "properties":{
        "costReferenceGid":{
            "description":"The GID for the cost reference.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The GID for the shipment cost reference.",
            "type":"string"
        },
        "vatBasisAmount":{
            "description":"Allocated basis on which VAT is calculated for this cost reference item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatAmount":{
            "description":"Monetary value of VAT for this cost reference item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vatAmount

Monetary value of VAT for this cost reference item.

Match All

Monetary value of VAT for this cost reference item.

Show Source

• object currencyType

{
    "description":"Monetary value of VAT for this cost reference item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : vatBasisAmount

Allocated basis on which VAT is calculated for this cost reference item.

Match All

Allocated basis on which VAT is calculated for this cost reference item.

Show Source

• object currencyType

{
    "description":"Allocated basis on which VAT is calculated for this cost reference item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.lineItems.vouchers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.lineItems.vouchers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.lineItems.vouchers

Type: object

Show Source

• adjustmentReasonGid: string
  The GID for the adjustment reason.
• amountPaid: amountPaid
  Amount paid.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• links: array links
  Read Only: true
• voucher: voucher
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• voucherGid: string
  The GID for the voucher.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "voucherGid":{
            "description":"The GID for the voucher. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "voucher":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/vouchers"
                }
            ],
            "readOnly":true
        },
        "amountPaid":{
            "description":"Amount paid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "adjustmentReasonGid":{
            "description":"The GID for the adjustment reason.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : amountPaid

Amount paid.

Match All

Amount paid.

Show Source

• object currencyType

{
    "description":"Amount paid.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : voucher

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object vouchers

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property voucherGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/vouchers"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.notes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.notes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.notes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• enteredBy: string
  The name and domain of the person who entered notes about the invoice.
• invoiceNoteSeqNo: number (int64)
  The Invoice Note Sequence number specifies the order of notes on the invoice or bill.
• isSystemGenerated: boolean
  Indicates whether this is system generated or not.
• links: array links
  Read Only: true
• note: string
  The note(s) about the invoice.
• summary: string
  Summary.
• timestamp: timestamp
  The day, month, and year of the note on the invoice.

{
    "properties":{
        "invoiceNoteSeqNo":{
            "description":"The Invoice Note Sequence number specifies the order of notes on the invoice or bill.",
            "type":"number",
            "format":"int64"
        },
        "timestamp":{
            "description":"The day, month, and year of the note on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "summary":{
            "description":"Summary.",
            "type":"string"
        },
        "note":{
            "description":"The note(s) about the invoice.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Indicates whether this is system generated or not.",
            "type":"boolean"
        },
        "enteredBy":{
            "description":"The name and domain of the person who entered notes about the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : timestamp

The day, month, and year of the note on the invoice.

Match All

The day, month, and year of the note on the invoice.

Show Source

• object dateTimeType

{
    "description":"The day, month, and year of the note on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.orderReleases

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.orderReleases"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.orderReleases

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• orderRelease: orderRelease
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderReleaseGid: string
  A GID created by the system for the order release.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)

{
    "properties":{
        "orderReleaseGid":{
            "description":"A GID created by the system for the order release. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderRelease":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderReleases"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderRelease

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderReleaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderReleases"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.ports

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.ports"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.ports

Type: object

Show Source

• countryCode3Gid: string
  The country code GID.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationIdentifier: string
  The location identifier.
• locationIdentifierQualifier: string
  The qualifier associated with the location identifier.
• portFunctionCode: string
  The port function code.
• portName: string
  The name of the port on the invoice.
• portSeqNo: number (int32)
  The sequence number for the port on the invoice.
• provinceCode: string
  The province code on the invoice.

{
    "properties":{
        "portSeqNo":{
            "description":"The sequence number for the port on the invoice.",
            "type":"number",
            "format":"int32"
        },
        "portFunctionCode":{
            "description":"The port function code.",
            "type":"string"
        },
        "locationIdentifier":{
            "description":"The location identifier.",
            "type":"string"
        },
        "locationIdentifierQualifier":{
            "description":"The qualifier associated with the location identifier.",
            "type":"string"
        },
        "portName":{
            "description":"The name of the port on the invoice.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code on the invoice.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.protectiveServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.protectiveServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.protectiveServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• protSrvCode: string
  Protective service code.
• protSrvRuleCode: string
  Protective service rule code.
• protSrvSeqNo: number (int32)
  Protective service sequence number.
• protSrvTemp: protSrvTemp
  Temperature requirement.

{
    "properties":{
        "protSrvSeqNo":{
            "description":"Protective service sequence number.",
            "type":"number",
            "format":"int32"
        },
        "protSrvCode":{
            "description":"Protective service code.",
            "type":"string"
        },
        "protSrvRuleCode":{
            "description":"Protective service rule code.",
            "type":"string"
        },
        "protSrvTemp":{
            "description":"Temperature requirement.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : protSrvTemp

Temperature requirement.

Match All

Temperature requirement.

Show Source

• object amountType

{
    "description":"Temperature requirement.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• invoiceRefnumQualGid: string
  The GID for the reference number (PONUMBER, VATNUMBER, CUSTPONUMBER).
• invoiceRefnumValue: string
  Value of entered for the Reference Number Qualifier.
• issueDate: issueDate
  The date the invoice was issued.
• links: array links
  Read Only: true

{
    "properties":{
        "invoiceRefnumQualGid":{
            "description":"The GID for the reference number (PONUMBER, VATNUMBER, CUSTPONUMBER).",
            "type":"string"
        },
        "invoiceRefnumValue":{
            "description":"Value of entered for the Reference Number Qualifier.",
            "type":"string"
        },
        "issueDate":{
            "description":"The date the invoice was issued.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : issueDate

The date the invoice was issued.

Match All

The date the invoice was issued.

Show Source

• object dateType

{
    "description":"The date the invoice was issued.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualIdentifier: string
  Remark qualifier.
• remarkSeqNo: number (int64)
  A sequence number for a remark on an invoice.
• remarkText: string
  The text for the remark on an invoice.

{
    "properties":{
        "remarkSeqNo":{
            "description":"A sequence number for a remark on an invoice.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualIdentifier":{
            "description":"Remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text for the remark on an invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.routes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.routes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.routes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• intermodalServiceCode: string
  Intermodal service code.
• jctCityCode: string
  Junction city code.
• links: array links
  Read Only: true
• routeSeqNo: number (int32)
  The sequence number for the route on an invoice.
• servprovAliasQualGid: string
  The service provider alias qualifier GID.
• servprovAliasValue: string
  Service provider associated with the route.
• transportModeIdentifier: string
  The transport mode identifier.

{
    "properties":{
        "routeSeqNo":{
            "description":"The sequence number for the route on an invoice.",
            "type":"number",
            "format":"int32"
        },
        "transportModeIdentifier":{
            "description":"The transport mode identifier.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"The service provider alias qualifier GID.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"Service provider associated with the route.",
            "type":"string"
        },
        "intermodalServiceCode":{
            "description":"Intermodal service code.",
            "type":"string"
        },
        "jctCityCode":{
            "description":"Junction city code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.shipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.shipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.shipments

Type: object

Show Source

• costs: costs
• domainName: string
  Database domain where this data is stored.
• lineitemSeqNo: number (int64)
  Line item sequence number.
• links: array links
  Read Only: true
• sequenceNo: number (int64)
  Sequence number.
• shipGroup: shipGroup
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipGroupGid: string
  This column is to generate invoice based on shipment group. Here the shipment group can have only one invoice associated to it.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• shipment: shipment
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• shipmentGid: string
  The GID for the shipment.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• sShipUnitGid: string
  The GID for the shipment ship unit.
• sShipUnitLineNo: number (int64)
  The shipment ship unit line number.
• trackingNumber: string
  Tracking number

{
    "properties":{
        "sequenceNo":{
            "description":"Sequence number.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"The GID for the shipment. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipment":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/sellShipments"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"The GID for the shipment ship unit.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"The shipment ship unit line number.",
            "type":"number",
            "format":"int64"
        },
        "trackingNumber":{
            "description":"Tracking number",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"Line item sequence number.",
            "type":"number",
            "format":"int64"
        },
        "shipGroupGid":{
            "description":"This column is to generate invoice based on shipment group. Here the shipment group can have only one  invoice associated to it. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "shipGroup":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/shipmentGroups"
                }
            ],
            "readOnly":true
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.shipments.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.shipments.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : shipGroup

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipGroupGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/shipmentGroups"
        }
    ],
    "readOnly":true
}

Nested Schema : shipment

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property shipmentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/sellShipments"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.shipments.costs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.shipments.costs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.shipments.costs

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code GID associated with the shipment cost.
• accessorialCostGid: string
  The accessorial cost GID associated with the shipment cost.
• adjustmentReasonGid: string
  The reason why this cost was added.
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency2: attributeCurrency2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency3: attributeCurrency3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate20: attributeDate20
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber20: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• billableIndicatorGid: string
  Indicates the billable status of this shipment cost (sell shipment only).
• cost: cost
  The cost as it relegates to the cost type for the shipment.
• costCategoryGid: string
  The Cost Category Identifier associated with the Shipment Cost
• costIdentifier: string
  It will be used to identify or describe a cost.
• costType: string
  C, A, B
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  The date to be used for any currency conversions; if null, the latest conversion is used.
• exchangeRateGid: string
  The set of exchange rates to use for currency conversions; if null, the default set is used.
• generalLedgerGid: string
  The GL code for the shipment cost record.
• isCostFixed: boolean
  Indicates shipment cost is a fixed cost.
• isWeighted: boolean
  Whether or not the cost affects the total weighted cost of the shipment only.
• links: array links
  Read Only: true
• paymentMethodCodeGid: string
  The payment method code for the shipment cost.
• processAsFlowThru: boolean
  The override for a record to be copied to the sell side during rating.
• rateGeoCostGroupGid: string
  The rate detail cost group GID associated with the shipment cost.
• rateGeoCostSeq: number (int64)
  The rate detail cost sequence identifier associated with the shipment cost.
• shipmentCostSeqno: number (int64)
  A system-generated unique sequence number to define the shipment costs.
• specialServiceGid: string
  The special service GID associated with the shipment cost.
• sShipUnitGid: string
  Points to the ship unit (if any) associated with this shipment cost, as a package.
• sShipUnitLineNo: number (int64)
  Points to the ship unit line (if any) associated with this shipment cost, as a package.
• trackingNumber: string
  Denotes the tracking number associated with a specific charge/cost.

{
    "properties":{
        "shipmentCostSeqno":{
            "description":"A system-generated unique sequence number to define the shipment costs.",
            "type":"number",
            "format":"int64"
        },
        "costType":{
            "description":"C, A, B",
            "type":"string"
        },
        "cost":{
            "description":"The cost as it relegates to the cost type for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"The accessorial code GID associated with the shipment cost.",
            "type":"string"
        },
        "accessorialCostGid":{
            "description":"The accessorial cost GID associated with the shipment cost.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"Indicates the billable status of this shipment cost (sell shipment only).",
            "type":"string"
        },
        "rateGeoCostGroupGid":{
            "description":"The rate detail cost group GID associated with the shipment cost.",
            "type":"string"
        },
        "rateGeoCostSeq":{
            "description":"The rate detail cost sequence identifier associated with the shipment cost.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service GID associated with the shipment cost.",
            "type":"string"
        },
        "isCostFixed":{
            "description":"Indicates shipment cost is a fixed cost.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"The override for a record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why this cost was added.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"The GL code for the shipment cost record.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method code for the shipment cost.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"The date to be used for any currency conversions; if null, the latest conversion is used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"The set of exchange rates to use for currency conversions; if null, the default set is used.",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"Points to the ship unit (if any) associated with this shipment cost, as a package.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"Points to the ship unit line (if any) associated with this shipment cost, as a package.",
            "type":"number",
            "format":"int64"
        },
        "isWeighted":{
            "description":"Whether or not the cost affects the total weighted cost of the shipment only.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costCategoryGid":{
            "description":"The Cost Category Identifier associated with the Shipment Cost",
            "type":"string"
        },
        "trackingNumber":{
            "description":"Denotes the tracking number associated with a specific charge/cost.",
            "type":"string"
        },
        "costIdentifier":{
            "description":"It will be used to identify or describe a cost.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150) ",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

The cost as it relegates to the cost type for the shipment.

Match All

The cost as it relegates to the cost type for the shipment.

Show Source

• object currencyType

{
    "description":"The cost as it relegates to the cost type for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

The date to be used for any currency conversions; if null, the latest conversion is used.

Match All

The date to be used for any currency conversions; if null, the latest conversion is used.

Show Source

• object dateType

{
    "description":"The date to be used for any currency conversions; if null, the latest conversion is used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The GID for the status type on the invoice.
• statusValueGid: string
  The GID for the status value on the invoice.

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the status type on the invoice.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The GID for the status value on the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.stops

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.stops"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.stops

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• endDate: endDate
  End date.
• equipmentNumber: string
  The equipment number on the invoice.
• equipmentPrefix: string
  Equipment prefix.
• invoiceStopReasonGid: string
  The invoice stop reason GID.
• links: array links
  Read Only: true
• location: location
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• locationGid: string
  The GID for the location on the invoice.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• locationRefnum: string
  A reference number for the location on the invoice.
• locationRefnumQualGid: string
  The location reference number qualifier GID.
• refnums: refnums
• seals: seals
• startDate: startDate
  Start date.
• stopSeqNo: string
  Stop sequence number.

{
    "properties":{
        "stopSeqNo":{
            "description":"Stop sequence number.",
            "type":"string"
        },
        "locationGid":{
            "description":"The GID for the location on the invoice. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "location":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "locationRefnumQualGid":{
            "description":"The location reference number qualifier GID.",
            "type":"string"
        },
        "locationRefnum":{
            "description":"A reference number for the location on the invoice.",
            "type":"string"
        },
        "invoiceStopReasonGid":{
            "description":"The invoice stop reason GID.",
            "type":"string"
        },
        "equipmentPrefix":{
            "description":"Equipment prefix.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The equipment number on the invoice.",
            "type":"string"
        },
        "startDate":{
            "description":"Start date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endDate":{
            "description":"End date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.stops.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.stops.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : endDate

End date.

Match All

End date.

Show Source

• object dateTimeType

{
    "description":"End date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : location

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property locationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.stops.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.stops.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : startDate

Start date.

Match All

Start date.

Show Source

• object dateTimeType

{
    "description":"Start date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.stops.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.stops.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.stops.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• invoiceStopRefnumQualGid: string
  The invoice stop reference number qualifier GID.
• links: array links
  Read Only: true
• referenceNumber: string
  Reference number.

{
    "properties":{
        "invoiceStopRefnumQualGid":{
            "description":"The invoice stop reference number qualifier GID.",
            "type":"string"
        },
        "referenceNumber":{
            "description":"Reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.stops.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.stops.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.stops.seals

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• sealNumber: string
  The number of the seal that was placed on the piece of equipment.
• sealSequence: number (int32)
  A one-up number to allow several seals being placed on a piece of equipment at the same stop.

{
    "properties":{
        "sealSequence":{
            "description":"A one-up number to allow several seals being placed on a piece of equipment at the same stop.",
            "type":"number",
            "format":"int32"
        },
        "sealNumber":{
            "description":"The number of the seal that was placed on the piece of equipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.summaries

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.summaries"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.summaries

Type: object

Show Source

• commercialUnitPrice: commercialUnitPrice
  Commercial unit price.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• freightCharge: freightCharge
  The total freight charge for the invoice.
• invoiceServiceCodeGid: string
  The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE. Summary level charges on invoice for service level. This is generally for air and ground.
• invoiceSummarySeqNo: number (int32)
  Sequence number for the invoice summary.
• invoiceTotal: number (int32)
  The count of the invoice's line items.
• links: array links
  Read Only: true
• prepaidAmount: prepaidAmount
  The dollar amount already paid on the invoice.
• remarks: remarks
• transportHandlingUnitGid: string
  The GID for the transport handling unit.
• unitCount: number (int64)
  The number of units on the invoice.
• volume: volume
  The total volume of items shipped for this invoice.
• weight: weight
  The total weight of all items shipped on this invoice.
• weightQualifier: string
  Weight qualifier.

{
    "properties":{
        "invoiceSummarySeqNo":{
            "description":"Sequence number for the invoice summary.",
            "type":"number",
            "format":"int32"
        },
        "freightCharge":{
            "description":"The total freight charge for the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "prepaidAmount":{
            "description":"The dollar amount already paid on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "commercialUnitPrice":{
            "description":"Commercial unit price.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"The number of units on the invoice.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "weight":{
            "description":"The total weight of all items shipped on this invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The total volume of items shipped for this invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "invoiceTotal":{
            "description":"The count of the invoice's line items.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "invoiceServiceCodeGid":{
            "description":"The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE. Summary level charges on invoice for service level. This is generally for air and ground.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/bills.summaries.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : commercialUnitPrice

Commercial unit price.

Match All

Commercial unit price.

Show Source

• object currencyType

{
    "description":"Commercial unit price.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : freightCharge

The total freight charge for the invoice.

Match All

The total freight charge for the invoice.

Show Source

• object currencyType

{
    "description":"The total freight charge for the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : prepaidAmount

The dollar amount already paid on the invoice.

Match All

The dollar amount already paid on the invoice.

Show Source

• object currencyType

{
    "description":"The dollar amount already paid on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.summaries.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The total volume of items shipped for this invoice.

Match All

The total volume of items shipped for this invoice.

Show Source

• object amountType

{
    "description":"The total volume of items shipped for this invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The total weight of all items shipped on this invoice.

Match All

The total weight of all items shipped on this invoice.

Show Source

• object amountType

{
    "description":"The total weight of all items shipped on this invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.summaries.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.summaries.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.summaries.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualIdentifier: string
  The qualifier for the remark.
• remarkSeqNo: number (int64)
  A sequence number for a remark on an invoice.
• remarkText: string
  The text of the remarks on the invoice.

{
    "properties":{
        "remarkSeqNo":{
            "description":"A sequence number for a remark on an invoice.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualIdentifier":{
            "description":"The qualifier for the remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remarks on the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.summaryDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.summaryDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.summaryDetails

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial code on the invoice.
• accessorialDescription: string
  The text describing the accessorial on the invoice.
• billedAsQualifier: string
  Billed as qualifier.
• billedAsQuantity: billedAsQuantity
  Billed as quantity.
• declaredValue: declaredValue
  The declared value of all items on the invoice.
• declaredValueQualGid: string
  The declared value qualifier GID.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
• freightCharge: freightCharge
  The total freight charge for shipping all items on the invoice.
• freightRateQualifier: string
  The freight rate qualifier.
• freightRateQuantity: freightRateQuantity
  Freight rate quantity.
• lineitemSeqNo: number (int32)
  The sequence number for the line item on the invoice.
• links: array links
  Read Only: true
• packagingUnitGid: string
  N/A
• paymentMethodCodeGid: string
  The GID for the payment method code.
• prepaidAmount: prepaidAmount
  The dollar amount already paid on the invoice.
• unitCount: number (int64)
  Unit count.
• volume: volume
  The total volume of the items shipped on the invoice.
• weight: weight
  The total weight of all items shipped on the invoice.
• weightQualifier: string
  Weight qualifier.

{
    "properties":{
        "lineitemSeqNo":{
            "description":"The sequence number for the line item on the invoice.",
            "type":"number",
            "format":"int32"
        },
        "billedAsQualifier":{
            "description":"Billed as qualifier.",
            "type":"string"
        },
        "billedAsQuantity":{
            "description":"Billed as quantity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "freightRateQualifier":{
            "description":"The freight rate qualifier.",
            "type":"string"
        },
        "freightRateQuantity":{
            "description":"Freight rate quantity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"N/A",
            "type":"string"
        },
        "weight":{
            "description":"The total weight of all items shipped on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The total volume of the items shipped on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "freightCharge":{
            "description":"The total freight charge for shipping all items on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "prepaidAmount":{
            "description":"The dollar amount already paid on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "paymentMethodCodeGid":{
            "description":"The GID for the payment method code.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial code on the invoice.",
            "type":"string"
        },
        "accessorialDescription":{
            "description":"The text describing the accessorial on the invoice.",
            "type":"string"
        },
        "declaredValueQualGid":{
            "description":"The declared value qualifier GID.",
            "type":"string"
        },
        "declaredValue":{
            "description":"The declared value of all items on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : billedAsQuantity

Billed as quantity.

Match All

Billed as quantity.

Show Source

• object currencyType

{
    "description":"Billed as quantity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : declaredValue

The declared value of all items on the invoice.

Match All

The declared value of all items on the invoice.

Show Source

• object currencyType

{
    "description":"The declared value of all items on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : freightCharge

The total freight charge for shipping all items on the invoice.

Match All

The total freight charge for shipping all items on the invoice.

Show Source

• object currencyType

{
    "description":"The total freight charge for shipping all items on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : freightRateQuantity

Freight rate quantity.

Match All

Freight rate quantity.

Show Source

• object currencyType

{
    "description":"Freight rate quantity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : prepaidAmount

The dollar amount already paid on the invoice.

Match All

The dollar amount already paid on the invoice.

Show Source

• object currencyType

{
    "description":"The dollar amount already paid on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : volume

The total volume of the items shipped on the invoice.

Match All

The total volume of the items shipped on the invoice.

Show Source

• object amountType

{
    "description":"The total volume of the items shipped on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The total weight of all items shipped on the invoice.

Match All

The total weight of all items shipped on the invoice.

Show Source

• object amountType

{
    "description":"The total weight of all items shipped on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.supplyProvinceVatRegs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.supplyProvinceVatRegs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.supplyProvinceVatRegs

Type: object

Show Source

• countryCode3Gid: string
  Country for the provincial registration.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• provinceCode: string
  Province of registration.
• vatProvincialRegGid: string
  The registration ID.

{
    "properties":{
        "countryCode3Gid":{
            "description":"Country for the provincial registration.",
            "type":"string"
        },
        "provinceCode":{
            "description":"Province of registration.",
            "type":"string"
        },
        "vatProvincialRegGid":{
            "description":"The registration ID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.texts

Type: object

Show Source

• documentDefGid: string
  Document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  Transactional override for the template on the specific document.
• textTemplateGid: string
  The GID for the text template. A Text Template is a predefined, formatted selection of text that is identified by a business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).

{
    "properties":{
        "textTemplateGid":{
            "description":"The GID for the text template. A Text Template is a predefined, formatted selection of text that is identified by a business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.vatAnalyses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.vatAnalyses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : bills.vatAnalyses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• links: array links
  Read Only: true
• taxAmount: taxAmount
  Amount of tax.
• vatBasisAmount: vatBasisAmount
  The portion of the invoice amount that will be taxed at the rate for the given VAT code
• vatCodeGid: string
  The GID for the vat code.
• vatRate: number (double)
  The tax rate that the basis amount will be taxed.

{
    "properties":{
        "vatCodeGid":{
            "description":"The GID for the vat code.",
            "type":"string"
        },
        "taxAmount":{
            "description":"Amount of tax.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "vatBasisAmount":{
            "description":"The portion of the invoice amount that will be taxed at the rate for the given VAT code",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatRate":{
            "description":"The tax rate that the basis amount will be taxed.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : taxAmount

Amount of tax.

Match All

Amount of tax.

Show Source

• object currencyType

{
    "description":"Amount of tax.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : vatBasisAmount

The portion of the invoice amount that will be taxed at the rate for the given VAT code

Match All

The portion of the invoice amount that will be taxed at the rate for the given VAT code

Show Source

• object currencyType

{
    "description":"The portion of the invoice amount that will be taxed at the rate for the given VAT code",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.allocations.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.allocations.details"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.allocations.details

Type: object

Show Source

• accessorialCodeGid: string
  No description.
• allocCostSeqno: number (int64)
  No description.
• attribute1: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute10: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute11: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute12: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute13: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute14: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute15: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute16: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute17: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute18: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute19: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute2: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute20: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute3: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute4: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute5: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute6: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute7: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute8: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attribute9: string
  Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).
• attributeCurrency1: attributeCurrency1
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency2: attributeCurrency2
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeCurrency3: attributeCurrency3
  Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.
• attributeDate1: attributeDate1
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate10: attributeDate10
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate11: attributeDate11
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate12: attributeDate12
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate13: attributeDate13
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate14: attributeDate14
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate15: attributeDate15
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate16: attributeDate16
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate17: attributeDate17
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate18: attributeDate18
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate19: attributeDate19
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate2: attributeDate2
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate20: attributeDate20
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate3: attributeDate3
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate4: attributeDate4
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate5: attributeDate5
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate6: attributeDate6
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate7: attributeDate7
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate8: attributeDate8
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeDate9: attributeDate9
  Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.
• attributeNumber1: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber10: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber11: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber12: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber13: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber14: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber15: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber16: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber17: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber18: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber19: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber2: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber20: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber3: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber4: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber5: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber6: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber7: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber8: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• attributeNumber9: number (double)
  Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.
• cost: cost
  No description.
• costDescription: string
  No description.
• costTypeGid: string
  No description.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• generalLedgerGid: string
  No description.
• invoiceGid: string
  No description.
• lineitemSeqNo: number (int32)
  No description.
• links: array links
  Read Only: true
• shipmentCostSeqno: number (int64)
  No description.
• shipmentGid: string
  No description.
• vatCodeGid: string
  The GID for the VAT tax that is being allocated from voucher.
• voucherGid: string
  No description.

{
    "properties":{
        "allocCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "costDescription":{
            "description":"No description.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"No description.",
            "type":"string"
        },
        "cost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "invoiceGid":{
            "description":"No description.",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "shipmentCostSeqno":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"No description.",
            "type":"string"
        },
        "voucherGid":{
            "description":"No description.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"No description.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is VARCHAR2 (150).",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is NUMBER.",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being allocated from voucher.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.

Show Source

• object currencyType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is Currency.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Match All

Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.

Show Source

• object dateTimeType

{
    "description":"Attribute (flex)fields allow you to add additional information about an object. Data type is DATE.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : cost

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

No description.

Match All

No description.

Show Source

• object dateType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.attributes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.attributes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.attributes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemFeatureQualGid: string
  The item feature qualifier identifier defining what type of feature this value is associated with.
• itemFeatureValue: string
  The item feature value for the order base line. This allows for further structural definition of an item such as size and color.
• links: array links
  Read Only: true

{
    "properties":{
        "itemFeatureQualGid":{
            "description":"The item feature qualifier identifier defining what type of feature this value is associated with.",
            "type":"string"
        },
        "itemFeatureValue":{
            "description":"The item feature value for the order base line. This allows for further structural definition of an item such as size and color.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.equipmentRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.equipmentRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.equipmentRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The total equipment reference units max consumption demand for this line.
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.
• totalNumReferenceUnits: number (double)
  The number of equipment reference units this line will consume when loading onto the equipment.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"The total equipment reference units max consumption demand for this line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.",
            "type":"number",
            "format":"double"
        },
        "totalNumReferenceUnits":{
            "description":"The number of equipment reference units this line will consume when loading onto the equipment.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method GID for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The contact GID for the involved party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The qualifier GID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier GID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact GID for the involved party. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method GID for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.packageRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.packageRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.packageRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagingReferenceUnitGid: string
  The packaging reference unit GID. The package reference unit (PRU) define another dimension to describe the consumption and capacity associated to building the order release ship units for transport. An example could be value of goods, loading meters, etc.
• totalPruCount: number (double)
  The total packaging unit reference (PRU) count being described as how much of the PRU does this line consume against the upper limit.
• unitPruCount: number (double)
  The packaging unit reference (PRU) count being described as how much of the PRU does this line consume.

{
    "properties":{
        "packagingReferenceUnitGid":{
            "description":"The packaging reference unit GID. The package reference unit (PRU) define another dimension to describe the consumption and capacity associated to building the order release ship units for transport. An example could be value of goods, loading meters, etc.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "unitPruCount":{
            "description":"The packaging unit reference (PRU) count being described as how much of the PRU does this line consume.",
            "type":"number",
            "format":"double"
        },
        "totalPruCount":{
            "description":"The total packaging unit reference (PRU) count being described as how much of the PRU does this line consume against the upper limit. ",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• obLineRefnumQualGid: string
  The reference number qualifier GID defining the reference code.
• obLineRefnumValue: string
  The text associated to the remark code.

{
    "properties":{
        "obLineRefnumQualGid":{
            "description":"The reference number qualifier GID defining the reference code.",
            "type":"string"
        },
        "obLineRefnumValue":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.releaseInstructions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.releaseInstructions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.releaseInstructions

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• destLocation: destLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destLocationGid: string
  The destination location GID for the delivery of the order base ship unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• earlyDeliveryDate: earlyDeliveryDate
  The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
• earlyPickupDate: earlyPickupDate
  The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.
• flaggedForDelete: boolean
  A Y/N indicator specifying that the release instruction can be deleted by an agent or user defined process.
• isAutoRelease: boolean
  A Y/N indicator to create the order release ship unit from the release instruction that comes in with the order base ship unit initially.
• isProcessed: boolean
  Read Only: true

  A Y/N indicator specifying that the release instruction was processed to create an order release line.
• lateDeliveryDate: lateDeliveryDate
  The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
• latePickupDate: latePickupDate
  The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.
• links: array links
  Read Only: true
• obReleaseInstrGid: string
  The GID for the release instruction associated to the order base line.
• obReleaseInstructionSeq: number (int64)
  The sequence number (key) associated with the release instruction.
• obReleaseInstrXid: string
  The XID for the release instruction.
• obSuReleaseInstructionGid: string
  The order base ship unit release instruction GID that is used for the order configuration type of directed pack. Here you supply the line level information together with the ship unit instructions for creating the order release ship unit from this instruction instead of prepack, autocalc, or one to one.
• orderBase: orderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderBaseGid: string
  The order base GID associated with the release instruction.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• quantityQualifierGid: string
  The quantity qualifier dimension to be used for this instruction - such as weight, volume or count.
• refnums: refnums
• releaseDate: releaseDate
  The date the release instruction is to be processed.
• remarks: remarks
• shipUnitCount: number (int64)
  The ship unit count value that can be copied to the order release for a specific case of handling line based releases with some limited ship unit information.
• shipWithGroup: string
  The ship with group identifier that is added to the order release to group them together onto the same shipment.
• sourceLocation: sourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourceLocationGid: string
  The source location GID for the pickup of the order base ship unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• tag1: string
  Additional information about the item. Like the color or code number.
• tag2: string
  Additional information about the item. Like the color or code number.
• tag3: string
  Additional information about the item. Like the color or code number.
• tag4: string
  Additional information about the item. Like the color or code number.
• totalVolume: totalVolume
  The total volume of the ship units for this release instruction.
• totalWeight: totalWeight
  The total weight of the ship units for this release instruction.
• transportHandlingUnitGid: string
  The transport handling unit for the ship Unit count value that can be copied to the order release for a specific case of handling line based releases with some limited ship unit information.
• unitValue: number (int64)
  The unit count if the instruction in packaged item count based.
• volumeValue: volumeValue
  The volume for the release instruction.
• weightValue: weightValue
  The weight for the release instruction.

{
    "properties":{
        "obReleaseInstrGid":{
            "description":"The GID for the release instruction associated to the order base line.",
            "type":"string"
        },
        "obReleaseInstrXid":{
            "description":"The XID for the release instruction.",
            "type":"string"
        },
        "orderBaseGid":{
            "description":"The order base GID associated with the release instruction. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "obReleaseInstructionSeq":{
            "description":"The sequence number (key) associated with the release instruction.",
            "type":"number",
            "format":"int64"
        },
        "quantityQualifierGid":{
            "description":"The quantity qualifier dimension to be used for this instruction - such as weight, volume or count.",
            "type":"string"
        },
        "isProcessed":{
            "description":"A Y/N indicator specifying that the release instruction was processed to create an order release line.",
            "type":"boolean",
            "readOnly":true
        },
        "sourceLocationGid":{
            "description":"The source location GID for the pickup of the order base ship unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destLocationGid":{
            "description":"The destination location GID for the delivery of the order base ship unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "earlyDeliveryDate":{
            "description":"The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lateDeliveryDate":{
            "description":"The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "earlyPickupDate":{
            "description":"The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latePickupDate":{
            "description":"The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "releaseDate":{
            "description":"The date the release instruction is to be processed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "weightValue":{
            "description":"The weight for the release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volumeValue":{
            "description":"The volume for the release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitValue":{
            "description":"The unit count if the instruction in packaged item count based.",
            "type":"number",
            "format":"int64"
        },
        "tag1":{
            "description":"Additional information about the item. Like the color or code number.",
            "type":"string"
        },
        "tag2":{
            "description":"Additional information about the item. Like the color or code number.",
            "type":"string"
        },
        "tag3":{
            "description":"Additional information about the item. Like the color or code number.",
            "type":"string"
        },
        "tag4":{
            "description":"Additional information about the item. Like the color or code number.",
            "type":"string"
        },
        "flaggedForDelete":{
            "description":"A Y/N indicator specifying that the release instruction can be deleted by an agent or user defined process.",
            "type":"boolean"
        },
        "totalWeight":{
            "description":"The total weight of the ship units for this release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"The total volume of the ship units for this release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "shipUnitCount":{
            "description":"The ship unit count value that can be copied to the order release for a specific case of handling line based releases with some limited ship unit information.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit for the ship Unit count value that can be copied to the order release for a specific case of handling line based releases with some limited ship unit information.",
            "type":"string"
        },
        "isAutoRelease":{
            "description":"A Y/N indicator to create the order release ship unit from the release instruction that comes in with the order base ship unit initially.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "shipWithGroup":{
            "description":"The ship with group identifier that is added to the order release to group them together onto the same shipment.",
            "type":"string"
        },
        "obSuReleaseInstructionGid":{
            "description":"The order base ship unit release instruction GID that is used for the order configuration type of directed pack. Here you supply the line level information together with the ship unit instructions for creating the order release ship unit from this instruction instead of prepack, autocalc, or one to one.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.releaseInstructions.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.lines.releaseInstructions.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : destLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : earlyDeliveryDate

The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.

Match All

The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.

Show Source

• object dateTimeType

{
    "description":"The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : earlyPickupDate

The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.

Match All

The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.

Show Source

• object dateTimeType

{
    "description":"The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : lateDeliveryDate

The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.

Match All

The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.

Show Source

• object dateTimeType

{
    "description":"The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : latePickupDate

The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.

Match All

The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.

Show Source

• object dateTimeType

{
    "description":"The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.releaseInstructions.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : releaseDate

The date the release instruction is to be processed.

Match All

The date the release instruction is to be processed.

Show Source

• object dateTimeType

{
    "description":"The date the release instruction is to be processed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.lines.releaseInstructions.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : totalVolume

The total volume of the ship units for this release instruction.

Match All

The total volume of the ship units for this release instruction.

Show Source

• object amountType

{
    "description":"The total volume of the ship units for this release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

The total weight of the ship units for this release instruction.

Match All

The total weight of the ship units for this release instruction.

Show Source

• object amountType

{
    "description":"The total weight of the ship units for this release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volumeValue

The volume for the release instruction.

Match All

The volume for the release instruction.

Show Source

• object amountType

{
    "description":"The volume for the release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weightValue

The weight for the release instruction.

Match All

The weight for the release instruction.

Show Source

• object amountType

{
    "description":"The weight for the release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.releaseInstructions.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.releaseInstructions.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.releaseInstructions.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• orderReleaseRefnumQualGid: string
  The reference number qualifier identifier defining the reference code.
• orderReleaseRefnumValue: string
  The text associated to the reference code.

{
    "properties":{
        "orderReleaseRefnumQualGid":{
            "description":"The reference number qualifier identifier defining the reference code.",
            "type":"string"
        },
        "orderReleaseRefnumValue":{
            "description":"The text associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.releaseInstructions.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.releaseInstructions.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.releaseInstructions.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the order base line release instruction.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the order base line release instruction.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier GID defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the order base line.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the order base line.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier GID defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.lines.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.lines.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.lines.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type GID for the status value on the order base line.
• statusValueGid: string
  The status value for the order base line status.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type GID for the status value on the order base line.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the order base line status.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• obRefnumQualGid: string
  The reference qualifier GID defining the reference code.
• obRefnumValue: string
  The value associated to the reference code.

{
    "properties":{
        "obRefnumQualGid":{
            "description":"The reference qualifier GID defining the reference  code.",
            "type":"string"
        },
        "obRefnumValue":{
            "description":"The value associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type. For example: external order number or purchase number.
• remarkSequence: number (int64)
  The sequence (key) for the remark.
• remarkText: string
  A user-entered remark.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence (key) for the remark.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type. For example: external order number or purchase number.",
            "type":"string"
        },
        "remarkText":{
            "description":"A user-entered remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits

Type: object

Show Source

• accessorials: accessorials
• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• bufferLocation: bufferLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• bufferLocationGid: string
  The buffer location to identify if this order base ship unit is being modeled with a buffer location to hold inventory prior to final delivery.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• contents: contents
• coreDiameter: coreDiameter
  For cylindrical objects, this defines the diameter of the core.
• declaredValue: declaredValue
  The declared value of the total of the goods, ship unit content lines on the ship unit.
• deliveryIsAppt: boolean
  Indicates if the early/late delivery times are appointment times
• destLocationGid: string
  The destination location GID for the delivery location associated with this order base ship unit.
• diameter: diameter
  The unit diameter of the ship unit.
• domainName: string
  Database domain where this data is stored.
• earlyDeliveryDate: earlyDeliveryDate
  The earliest date when the item can be delivered.
• earlyPickupDate: earlyPickupDate
  The earliest date when the item can be picked up.
• equipmentRefUnits: equipmentRefUnits
• flexCommodityCode: string
  The user defined commodity code for the item. E.g.. HTS, SITC, STCC, NMFC
• flexCommodityQualGid: string
  The user defined commodity qualifier identify the type of commodity classification being used, such as NMFC.
• height: height
  The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.
• involvedParties: involvedParties
• isShippable: boolean
  A Y/N indicator defining if the order base line is ready to be shipped by creating an order release for it.
• lateDeliveryDate: lateDeliveryDate
  The latest date when the item can be picked delivered.
• latePickupDate: latePickupDate
  The latest date when the item can be picked up.
• length: length
  The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.
• links: array links
  Read Only: true
• loadConfigSetupGid: string
  A load configurator set up identifier to be used by the load configuration engine as the input rules for how the ship unit was built.
• loadingSplits: loadingSplits
• loadPoint: string
  The specific loading location for the source location on the ship unit.
• netVolume: netVolume
  The total net volume of the ship unit content lines on the ship unit.
• netWeight: netWeight
  The total net weight of the ship unit content lines on the ship unit.
• obShipUnitGid: string
  The GID for the ship unit associated to an order base.
• obShipUnitXid: string
  The XID for the ship unit associated to a order base.
• pickupIsAppt: boolean
  Indicates if the early/late pickup times are appointment times
• planFromLoadPoint: string
  The specific loading location for the plan from location on the ship unit.
• planFromLocationGid: string
  The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.
• planToLocationGid: string
  The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.
• planToUnloadPoint: string
  The specific unloading location for the plan to location on the ship unit.
• refnums: refnums
• releasedCount: number (int64)
  Read Only: true

  The number of ship units that have been processed onto order release through the releasing logic.
• releaseInstructions: releaseInstructions
• remarks: remarks
• seals: seals
• shipUnitCount: number (int64)
  The number of ship units this entry represents. Ship unit count of 1 to model discrete ship units and bulk orders. Greater than 1 to model multiple uniform ship units.
• sourceLocationGid: string
  The source location GID for the pickup location associated with this order base ship unit.
• specialServices: specialServices
• splittableBy: string
  Indicates how the resulting order release ship unit may be split across equipment.
• statuses: statuses
• tag1: string
  Additional information about the item. Like the color or size code, etc.
• tag2: string
  Additional information about the item. Like the color or size code, etc.
• tag3: string
  Additional information about the item. Like the color or size code, etc.
• tag4: string
  Additional information about the item. Like the color or size code, etc.
• transportHandlingUnitGid: string
  The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.
• unloadPoint: string
  The specific unloading location for the delivery location on the ship unit.
• volume: volume
  The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.
• weight: weight
  The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.
• width: width
  The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.

{
    "properties":{
        "obShipUnitGid":{
            "description":"The GID for the ship unit associated to an order base.",
            "type":"string"
        },
        "obShipUnitXid":{
            "description":"The XID for the ship unit associated to a order base.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit identifier defined for the ship unit. Examples are a box and a pallet.",
            "type":"string"
        },
        "shipUnitCount":{
            "description":"The number of ship units this entry represents. Ship unit count of 1 to model discrete ship units and bulk orders. Greater than 1 to model multiple uniform ship units.",
            "type":"number",
            "format":"int64"
        },
        "sourceLocationGid":{
            "description":"The source location GID for the pickup location associated with this order base ship unit.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The destination location GID for the delivery location associated with this order base ship unit.",
            "type":"string"
        },
        "earlyPickupDate":{
            "description":"The earliest date when the item can be picked up.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latePickupDate":{
            "description":"The latest date when the item can be picked up.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "earlyDeliveryDate":{
            "description":"The earliest date when the item can be delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lateDeliveryDate":{
            "description":"The latest date when the item can be picked delivered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "weight":{
            "description":"The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "length":{
            "description":"The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of each order base ship unit. Each row may represent the ship unit count number of same ship units. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"The declared value of the total of the goods, ship unit content lines on the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "flexCommodityCode":{
            "description":"The user defined commodity code for the item. E.g.. HTS, SITC, STCC, NMFC",
            "type":"string"
        },
        "flexCommodityQualGid":{
            "description":"The user defined commodity qualifier identify the type of commodity classification being used, such as NMFC.",
            "type":"string"
        },
        "planFromLocationGid":{
            "description":"The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.",
            "type":"string"
        },
        "planToLocationGid":{
            "description":"The plan from location GID can define a location other than the source location of the ship unit for OTM to beginning planning transport.",
            "type":"string"
        },
        "netWeight":{
            "description":"The total net weight of the ship unit content lines on the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "netVolume":{
            "description":"The total net volume of the ship unit content lines on the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isShippable":{
            "description":"A Y/N indicator defining if the order base line is ready to be shipped by creating an order release for it.",
            "type":"boolean"
        },
        "releasedCount":{
            "description":"The number of ship units that have been processed onto order release through the releasing logic.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "loadPoint":{
            "description":"The specific loading location for the source location on the ship unit.",
            "type":"string"
        },
        "unloadPoint":{
            "description":"The specific unloading location for the delivery location on the ship unit.",
            "type":"string"
        },
        "pickupIsAppt":{
            "description":"Indicates if the early/late pickup times are appointment times",
            "type":"boolean"
        },
        "deliveryIsAppt":{
            "description":"Indicates if the early/late delivery times are appointment times",
            "type":"boolean"
        },
        "planFromLoadPoint":{
            "description":"The specific loading location for the plan from location on the ship unit.",
            "type":"string"
        },
        "planToUnloadPoint":{
            "description":"The specific unloading location for the plan to location on the ship unit.",
            "type":"string"
        },
        "tag1":{
            "description":"Additional information about the item. Like the color or size code, etc.",
            "type":"string"
        },
        "tag2":{
            "description":"Additional information about the item. Like the color or size code, etc.",
            "type":"string"
        },
        "tag3":{
            "description":"Additional information about the item. Like the color or size code, etc.",
            "type":"string"
        },
        "tag4":{
            "description":"Additional information about the item. Like the color or size code, etc.",
            "type":"string"
        },
        "coreDiameter":{
            "description":"For cylindrical objects, this defines the diameter of the core.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "diameter":{
            "description":"The unit diameter of the ship unit.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "bufferLocationGid":{
            "description":"The buffer location to identify if this order base ship unit is being modeled with a buffer location to hold inventory prior to final delivery. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "bufferLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "loadConfigSetupGid":{
            "description":"A load configurator set up identifier to be used by the load configuration engine as the input rules for how the ship unit was built.",
            "type":"string"
        },
        "splittableBy":{
            "description":"Indicates how the resulting order release ship unit may be split across equipment.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "equipmentRefUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.equipmentRefUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "accessorials":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.accessorials"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "specialServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.specialServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "releaseInstructions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "loadingSplits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.loadingSplits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : accessorials

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : bufferLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property bufferLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : contents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.contents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : coreDiameter

For cylindrical objects, this defines the diameter of the core.

Match All

For cylindrical objects, this defines the diameter of the core.

Show Source

• object amountType

{
    "description":"For cylindrical objects, this defines the diameter of the core.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : declaredValue

The declared value of the total of the goods, ship unit content lines on the ship unit.

Match All

The declared value of the total of the goods, ship unit content lines on the ship unit.

Show Source

• object currencyType

{
    "description":"The declared value of the total of the goods, ship unit content lines on the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : diameter

The unit diameter of the ship unit.

Match All

The unit diameter of the ship unit.

Show Source

• object amountType

{
    "description":"The unit diameter of the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : earlyDeliveryDate

The earliest date when the item can be delivered.

Match All

The earliest date when the item can be delivered.

Show Source

• object dateTimeType

{
    "description":"The earliest date when the item can be delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : earlyPickupDate

The earliest date when the item can be picked up.

Match All

The earliest date when the item can be picked up.

Show Source

• object dateTimeType

{
    "description":"The earliest date when the item can be picked up.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentRefUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.equipmentRefUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : height

The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.

Match All

The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.

Show Source

• object amountType

{
    "description":"The height of each order base ship unit. If this row represents the 20 same ship units, the total height is 20 x unit height.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lateDeliveryDate

The latest date when the item can be picked delivered.

Match All

The latest date when the item can be picked delivered.

Show Source

• object dateTimeType

{
    "description":"The latest date when the item can be picked delivered.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : latePickupDate

The latest date when the item can be picked up.

Match All

The latest date when the item can be picked up.

Show Source

• object dateTimeType

{
    "description":"The latest date when the item can be picked up.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : length

The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.

Match All

The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.

Show Source

• object amountType

{
    "description":"The length of each order base ship unit. If this row represents 20 of the same ship units, the total length is 20 x unit length.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : loadingSplits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.loadingSplits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : netVolume

The total net volume of the ship unit content lines on the ship unit.

Match All

The total net volume of the ship unit content lines on the ship unit.

Show Source

• object amountType

{
    "description":"The total net volume of the ship unit content lines on the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : netWeight

The total net weight of the ship unit content lines on the ship unit.

Match All

The total net weight of the ship unit content lines on the ship unit.

Show Source

• object amountType

{
    "description":"The total net weight of the ship unit content lines on the ship unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : releaseInstructions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : specialServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.specialServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.

Match All

The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.

Show Source

• object amountType

{
    "description":"The gross volume of the ship unit, the sum of the ship unit line contents volume plus the tare volume of the transport handling unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.

Match All

The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.

Show Source

• object amountType

{
    "description":"The gross weight of the ship unit, the sum of the ship unit line contents weight plus the tare weight of the transport handling unit.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.

Match All

The width of each order base ship unit. Each row may represent the ship unit count number of same ship units.

Show Source

• object amountType

{
    "description":"The width of each order base ship unit. Each row may represent the ship unit count number of same ship units. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.accessorials

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.accessorials"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.accessorials

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code used to specify that this accessorial needs to be copied to the order release and covered when planning the shipment.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The accessorial code used to specify that this accessorial needs to be copied to the order release and covered when planning the shipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.contents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.contents

Type: object

Show Source

• attributes: attributes
• countPerShipUnit: number (int64)
  The packaged item count per ship unit order base content line count to handle shipping a multiple count number of ship units.
• declaredValue: declaredValue
  The declared value, commercial value of the ship unit line contents for sale of goods.
• domainName: string
  Database domain where this data is stored.
• initialItem: initialItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• initialItemGid: string
  The initial packaged item GID, this value can be used to handle the original packaged item order and the substituted and item to be processed in the packaged item GID field.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedParties: involvedParties
• links: array links
  Read Only: true
• packagedCount: number (int64)
  The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
• packagedItem: packagedItem
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• packagedItemGid: string
  The packaged item GID defining the content line for the ship unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• packagingUnitCount: number (int64)
  The packaging unit count for the inner pack.
• packagingUnitGid: string
  The packaging unit identifier for any inner packaging associated to the ship unit such as carton configuration.
• refnums: refnums
• remarks: remarks
• sequenceNo: number (int64)
  The unique sequence within the ship unit to define the individual line items.
• tag1: string
  Additional information about the item. Like the color, size, code.
• tag2: string
  Additional information about the item. Like the color, size, code.
• tag3: string
  Additional information about the item. Like the color, size, code.
• tag4: string
  Additional information about the item. Like the color, size, code.
• volume: volume
  The gross volume of the item.
• volumePerShipUnit: volumePerShipUnit
  The volume per order base content line to handle shipping a multiple count number of ship units.
• weight: weight
  The gross weight of the item.
• weightPerShipUnit: weightPerShipUnit
  The weight per ship unit order base content line to handle shipping a multiple count number of ship units.

{
    "properties":{
        "sequenceNo":{
            "description":"The unique sequence within the ship unit to define the individual line items.",
            "type":"number",
            "format":"int64"
        },
        "packagedItemGid":{
            "description":"The packaged item GID defining the content line for the ship unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "packagedItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/packagedItems"
                }
            ],
            "readOnly":true
        },
        "initialItemGid":{
            "description":"The initial packaged item GID, this value can be used to handle the original packaged item order and the substituted and item to be processed in the packaged item GID field. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "initialItem":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
                }
            ],
            "readOnly":true
        },
        "tag1":{
            "description":"Additional information about the item. Like the color, size, code.",
            "type":"string"
        },
        "tag2":{
            "description":"Additional information about the item. Like the color, size, code.",
            "type":"string"
        },
        "tag3":{
            "description":"Additional information about the item. Like the color, size, code.",
            "type":"string"
        },
        "tag4":{
            "description":"Additional information about the item. Like the color, size, code.",
            "type":"string"
        },
        "weight":{
            "description":"The gross weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The gross volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"The declared value, commercial value of the ship unit line contents for sale of goods.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packagedCount":{
            "description":"The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.",
            "type":"number",
            "format":"int64"
        },
        "weightPerShipUnit":{
            "description":"The weight per ship unit order base content line to handle shipping a multiple count number of ship units.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "countPerShipUnit":{
            "description":"The packaged item count per ship unit order base content line count to handle shipping a multiple count number of ship units.",
            "type":"number",
            "format":"int64"
        },
        "volumePerShipUnit":{
            "description":"The volume per order base content line to handle shipping a multiple count number of ship units.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packagingUnitGid":{
            "description":"The packaging unit identifier for any inner packaging associated to the ship unit such as carton configuration.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count for the inner pack.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "attributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents.attributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.contents.attributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

The declared value, commercial value of the ship unit line contents for sale of goods.

Match All

The declared value, commercial value of the ship unit line contents for sale of goods.

Show Source

• object currencyType

{
    "description":"The declared value, commercial value of the ship unit line contents for sale of goods.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : initialItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property initialItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/itemsWithProdClassCodeGid"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.contents.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : packagedItem

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object packagedItems

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property packagedItemGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/packagedItems"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.contents.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.contents.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The gross volume of the item.

Match All

The gross volume of the item.

Show Source

• object amountType

{
    "description":"The gross volume of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volumePerShipUnit

The volume per order base content line to handle shipping a multiple count number of ship units.

Match All

The volume per order base content line to handle shipping a multiple count number of ship units.

Show Source

• object amountType

{
    "description":"The volume per order base content line to handle shipping a multiple count number of ship units.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The gross weight of the item.

Match All

The gross weight of the item.

Show Source

• object amountType

{
    "description":"The gross weight of the item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weightPerShipUnit

The weight per ship unit order base content line to handle shipping a multiple count number of ship units.

Match All

The weight per ship unit order base content line to handle shipping a multiple count number of ship units.

Show Source

• object amountType

{
    "description":"The weight per ship unit order base content line to handle shipping a multiple count number of ship units.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents.attributes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.contents.attributes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.contents.attributes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemFeatureQualGid: string
  The item feature qualifier GID defining what type of feature this value is associated with.
• itemFeatureValue: string
  The item feature value for the order base line. This allows for future structural definition of an item such as size and color.
• links: array links
  Read Only: true

{
    "properties":{
        "itemFeatureQualGid":{
            "description":"The item feature qualifier GID defining what type of feature this value is associated with.",
            "type":"string"
        },
        "itemFeatureValue":{
            "description":"The item feature value for the order base line. This allows for future structural definition of an item such as size and color.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.contents.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.contents.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method ID for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The contact GID for the involved party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The qualifier GID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier GID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact GID for the involved party. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method ID for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.contents.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.contents.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• obSuContentRefnumQualGid: string
  The reference number qualifier GID defining the reference code.
• obSuContentRefnumValue: string
  The text associated to the reference code.

{
    "properties":{
        "obSuContentRefnumQualGid":{
            "description":"The reference number qualifier GID defining the reference code.",
            "type":"string"
        },
        "obSuContentRefnumValue":{
            "description":"The text associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.contents.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.contents.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier GID defining the remark code.
• remarkSequence: number (int64)
  The remark sequence identifier used for sequential ordering.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence identifier used for sequential ordering.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier GID defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.equipmentRefUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.equipmentRefUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.equipmentRefUnits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• equipmentReferenceUnitGid: string
  The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.
• links: array links
  Read Only: true
• numReferenceUnits: number (double)
  The number of equipment reference units this ship unit will consume when loading onto the equipment.
• totalNumReferenceUnits: number (double)
  The total equipment reference units max consumption demand for this ship unit.

{
    "properties":{
        "equipmentReferenceUnitGid":{
            "description":"The equipment reference unit, such as loading meter, that is referring to the equipment consumption value.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "numReferenceUnits":{
            "description":"The number of equipment reference units this ship unit will consume when loading onto the equipment.",
            "type":"number",
            "format":"double"
        },
        "totalNumReferenceUnits":{
            "description":"The total equipment reference units max consumption demand for this ship unit.",
            "type":"number",
            "format":"double"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method GID for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContact: involvedPartyContact
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• involvedPartyContactGid: string
  The contact GID for the involved party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• involvedPartyQualGid: string
  The qualifier GID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier GID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact GID for the involved party. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "involvedPartyContact":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/tradeParties"
                }
            ],
            "readOnly":true
        },
        "comMethodGid":{
            "description":"The communication method GID for the involved party.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : involvedPartyContact

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property involvedPartyContactGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/tradeParties"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.loadingSplits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.loadingSplits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.loadingSplits

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• height: height
  The height for the this part of the ship unit split.
• length: length
  The length for the this part of the ship unit split.
• links: array links
  Read Only: true
• splitNo: number (int32)
  The split number for the ship unit.
• volume: volume
  The volume for the this part of the ship unit split.
• weight: weight
  The weight for the this part of the ship unit split.
• width: width
  The width for the this part of the ship unit split.

{
    "properties":{
        "splitNo":{
            "description":"The split number for the ship unit.",
            "type":"number",
            "format":"int32"
        },
        "domainName":{
            "description":"Database domain where this data is stored. ",
            "type":"string"
        },
        "length":{
            "description":"The length for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"The weight for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume for the this part of the ship unit split.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : height

The height for the this part of the ship unit split.

Match All

The height for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The height for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

The length for the this part of the ship unit split.

Match All

The length for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The length for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : volume

The volume for the this part of the ship unit split.

Match All

The volume for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The volume for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight for the this part of the ship unit split.

Match All

The weight for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The weight for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width for the this part of the ship unit split.

Match All

The width for the this part of the ship unit split.

Show Source

• object amountType

{
    "description":"The width for the this part of the ship unit split.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• obShipUnitRefnumQualGid: string
  The reference number qualifier identifier defining the reference code.
• obShipUnitRefnumValue: string
  The text associated to the reference number code.

{
    "properties":{
        "obShipUnitRefnumQualGid":{
            "description":"The reference number qualifier identifier defining the reference code.",
            "type":"string"
        },
        "obShipUnitRefnumValue":{
            "description":"The text associated to the reference number code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.releaseInstructions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.releaseInstructions

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data type date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER
• destLocation: destLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• destLocationGid: string
  The destination location GID for the delivery of the order base ship unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• domainName: string
  Database domain where this data is stored.
• earlyDeliveryDate: earlyDeliveryDate
  The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
• earlyPickupDate: earlyPickupDate
  The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.
• flaggedForDelete: boolean
  A Y/N indicator specifying that the release instruction can be deleted by an agent or user defined process.
• height: height
  The height of the ship unit for the release instruction.
• isAutoRelease: boolean
  A Y/N indicator to create the order release ship unit from the release instruction that comes in with the order base ship unit initially.
• isProcessed: boolean
  Read Only: true

  A Y/N indicator specifying that the release instruction was processed to create an order release ship unit.
• itemPackageCount: number (int64)
  The number of packaged items on this ship unit release instruction.
• lateDeliveryDate: lateDeliveryDate
  The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.
• latePickupDate: latePickupDate
  The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.
• length: length
  The length of the ship unit for the release instruction.
• links: array links
  Read Only: true
• masterOrderBase: masterOrderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property masterOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• masterOrderBaseGid: string
  The master order base GID to be set on the order release created from the line. An order release can be created from multiple order bases and one of them is nominated as the master to get master level information for such as bill to party.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• obSuReleaseInstrGid: string
  The GID for the Release Instruction associated to the order base ship unit.
• obSuReleaseInstrXid: string
  The XID for the release instruction.
• orderBase: orderBase
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• orderBaseGid: string
  The order base GID for the release instruction.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• refnums: refnums
• releaseDate: releaseDate
  The date the release instruction should be processed.
• remarks: remarks
• sequenceNo: number (int64)
  The sequence number (key) associated with the release instruction.
• shipUnitReleaseCount: number (int64)
  The ship unit release count specifying the amount to be processed with this release instruction.
• shipWithGroup: string
  The ship with group value that will be used when creating the order release from this release instruction.
• sourceLocation: sourceLocation
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• sourceLocationGid: string
  The source location GID for the pickup of the order base ship unit.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• tag1: string
  Additional information about the item. Like the color or code number.
• tag2: string
  Additional information about the item. Like the color or code number.
• tag3: string
  Additional information about the item. Like the color or code number.
• tag4: string
  Additional information about the item. Like the color or code number.
• totalVolume: totalVolume
  The total volume of the ship units for this release instruction.
• totalWeight: totalWeight
  The total weight of the ship units for this release instruction.
• transportHandlingUnitGid: string
  The transport handling unit GID to be applied to the order release ship unit created with this release instruction.
• volume: volume
  The volume for the release instruction.
• weight: weight
  The weight for the release instruction.
• width: width
  The width of the ship unit for the release instruction.

{
    "properties":{
        "obSuReleaseInstrGid":{
            "description":"The GID for the Release Instruction associated to the order base ship unit.",
            "type":"string"
        },
        "obSuReleaseInstrXid":{
            "description":"The XID for the release instruction.",
            "type":"string"
        },
        "sequenceNo":{
            "description":"The sequence number (key) associated with the release instruction.",
            "type":"number",
            "format":"int64"
        },
        "orderBaseGid":{
            "description":"The order base GID for the release instruction. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "orderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "shipUnitReleaseCount":{
            "description":"The ship unit release count specifying the amount to be processed with this release instruction.",
            "type":"number",
            "format":"int64"
        },
        "isProcessed":{
            "description":"A Y/N indicator specifying that the release instruction was processed to create an order release ship unit.",
            "type":"boolean",
            "readOnly":true
        },
        "releaseDate":{
            "description":"The date the release instruction should be processed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The source location GID for the pickup of the order base ship unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "sourceLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "destLocationGid":{
            "description":"The destination location GID for the delivery of the order base ship unit. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "destLocation":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/locations"
                }
            ],
            "readOnly":true
        },
        "earlyDeliveryDate":{
            "description":"The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "lateDeliveryDate":{
            "description":"The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "earlyPickupDate":{
            "description":"The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "latePickupDate":{
            "description":"The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "flaggedForDelete":{
            "description":"A Y/N indicator specifying that the release instruction can be deleted by an agent or user defined process.",
            "type":"boolean"
        },
        "itemPackageCount":{
            "description":"The number of packaged items on this ship unit release instruction.",
            "type":"number",
            "format":"int64"
        },
        "weight":{
            "description":"The weight for the release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume for the release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "length":{
            "description":"The length of the ship unit for the release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the ship unit for the release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the ship unit for the release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalWeight":{
            "description":"The total weight of the ship units for this release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "totalVolume":{
            "description":"The total volume of the ship units for this release instruction.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "transportHandlingUnitGid":{
            "description":"The transport handling unit GID to be applied to the order release ship unit created with this release instruction.",
            "type":"string"
        },
        "isAutoRelease":{
            "description":"A Y/N indicator to create the order release ship unit from the release instruction that comes in with the order base ship unit initially.",
            "type":"boolean"
        },
        "tag1":{
            "description":"Additional information about the item. Like the color or code number.",
            "type":"string"
        },
        "tag2":{
            "description":"Additional information about the item. Like the color or code number.",
            "type":"string"
        },
        "tag3":{
            "description":"Additional information about the item. Like the color or code number.",
            "type":"string"
        },
        "tag4":{
            "description":"Additional information about the item. Like the color or code number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "shipWithGroup":{
            "description":"The ship with group value that will be used when creating the order release from this release instruction.",
            "type":"string"
        },
        "masterOrderBaseGid":{
            "description":"The master order base GID to be set on the order release created from the line. An order release can be created from multiple order bases and one of them is nominated as the master to get master level information for such as bill to party. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "masterOrderBase":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property masterOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/orderBases"
                }
            ],
            "readOnly":true
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Match All

Attribute fields (flexfields) allow you to add additional information about an object. Data type date

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data type date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : destLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property destLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : earlyDeliveryDate

The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.

Match All

The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.

Show Source

• object dateTimeType

{
    "description":"The earliest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : earlyPickupDate

The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.

Match All

The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.

Show Source

• object dateTimeType

{
    "description":"The earliest date when the item can be delivered. If a value is specified here it overrides that one defined on the order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : height

The height of the ship unit for the release instruction.

Match All

The height of the ship unit for the release instruction.

Show Source

• object amountType

{
    "description":"The height of the ship unit for the release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : lateDeliveryDate

The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.

Match All

The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.

Show Source

• object dateTimeType

{
    "description":"The latest date when the item can be picked up. If a value is specified here it overrides that one defined on the order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : latePickupDate

The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.

Match All

The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.

Show Source

• object dateTimeType

{
    "description":"The latest date when the item can be picked delivered. If a value is specified here it overrides that one defined on the order base line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : length

The length of the ship unit for the release instruction.

Match All

The length of the ship unit for the release instruction.

Show Source

• object amountType

{
    "description":"The length of the ship unit for the release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : masterOrderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property masterOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property masterOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property masterOrderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : orderBase

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property orderBaseGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/orderBases"
        }
    ],
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : releaseDate

The date the release instruction should be processed.

Match All

The date the release instruction should be processed.

Show Source

• object dateTimeType

{
    "description":"The date the release instruction should be processed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : sourceLocation

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object locations

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property sourceLocationGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/locations"
        }
    ],
    "readOnly":true
}

Nested Schema : totalVolume

The total volume of the ship units for this release instruction.

Match All

The total volume of the ship units for this release instruction.

Show Source

• object amountType

{
    "description":"The total volume of the ship units for this release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : totalWeight

The total weight of the ship units for this release instruction.

Match All

The total weight of the ship units for this release instruction.

Show Source

• object amountType

{
    "description":"The total weight of the ship units for this release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volume

The volume for the release instruction.

Match All

The volume for the release instruction.

Show Source

• object amountType

{
    "description":"The volume for the release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight for the release instruction.

Match All

The weight for the release instruction.

Show Source

• object amountType

{
    "description":"The weight for the release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width of the ship unit for the release instruction.

Match All

The width of the ship unit for the release instruction.

Show Source

• object amountType

{
    "description":"The width of the ship unit for the release instruction.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.releaseInstructions.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.releaseInstructions.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• orderReleaseRefnumQualGid: string
  The reference number qualifier GID defining the reference code.
• orderReleaseRefnumValue: string
  The text associated to the reference code.

{
    "properties":{
        "orderReleaseRefnumQualGid":{
            "description":"The reference number qualifier GID defining the reference code.",
            "type":"string"
        },
        "orderReleaseRefnumValue":{
            "description":"The text associated to the reference code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.releaseInstructions.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.releaseInstructions.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.releaseInstructions.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier GID defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the order base ship unit release instruction.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the order base ship unit release instruction.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarkQualGid":{
            "description":"The remark qualifier GID defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier identifier defining the remark code.
• remarkSequence: number (int64)
  The sequence identifier for the remark associated with the order base ship unit.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The sequence identifier for the remark associated with the order base ship unit.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.seals

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipUnitSeal: string
  The transport handling unit seal number for the order base ship unit.

{
    "properties":{
        "shipUnitSeal":{
            "description":"The transport handling unit seal number for the order base ship unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The special service identifier defining the special service that needs to be performed for the ship unit.

{
    "properties":{
        "specialServiceGid":{
            "description":"The special service identifier defining the special service that needs to be performed for the ship unit.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.shipUnits.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type GID for the status value on the order base.
• statusValueGid: string
  The status value for the order release base.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type GID for the status value on the order base.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the order release base.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.specialServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.specialServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.specialServices

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• specialServiceGid: string
  The special service code identifier defining the service required.

{
    "properties":{
        "specialServiceGid":{
            "description":"The special service code identifier defining the service required. ",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  The status type GID for the status value on the order base.
• statusValueGid: string
  The status value for the order base status.

{
    "properties":{
        "statusTypeGid":{
            "description":"The status type GID for the status value on the order base.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The status value for the order base status.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.texts

Type: object

Show Source

• documentDefGid: string
  A document that should hold text.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• textOverride: string
  The transactional override for the template on the specific document.
• textTemplateGid: string
  The foreign key to the text template table, in order to include fixed text with this order base.

{
    "properties":{
        "textTemplateGid":{
            "description":"The foreign key to the text template table, in order to include fixed text with this order base.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"A document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"The transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.trackingEvents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.trackingEvents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : orderBases.trackingEvents

Type: object

Show Source

• bsContactFunctionCode: string
  The contact name function code from the tracking event.
• bsContactName: string
  The contact name from the tracking event.
• bsReasonCodeGid: string
  The reason code from the tracking event that was matched to the order base.
• bsResponsiblePartyGid: string
  The responsible party identifier of the source of the tracking event.
• bsStatusCodeGid: string
  The status code identified on the tracking event.
• description: string
  A description of the tracking event.
• domainName: string
  Database domain where this data is stored.
• eventDate: eventDate
  The event date and time reported on the tracking event.
• iTransactionNo: number (int64)
  The transaction identifier for the order base data of the tracking event.
• links: array links
  Read Only: true
• obRefnumQualGid: string
  The order base reference number value associated with the order release qualifier that came on the tracking event.
• obRefnumValue: string
  The order base reference number qualifier identifier.
• reportingGluser: string
  The reporting application user if the tracking event was entered via the system's tracking event UI.
• servprovAliasQualGid: string
  The service provider alias qualifier code, such as SCAC, from the entered tracking event.
• servprovAliasValue: string
  The service provide alias value from the tracking event.
• statusLevel: string
  A descriptor code for the status level of the tracking event.
• timeZoneGid: string
  The time zone for the tracking event time entered.

{
    "properties":{
        "iTransactionNo":{
            "description":"The transaction identifier for the order base data of the tracking event.",
            "type":"number",
            "format":"int64"
        },
        "reportingGluser":{
            "description":"The reporting application user if the tracking event was entered via the system's tracking event UI.",
            "type":"string"
        },
        "bsContactName":{
            "description":"The contact name from the tracking event.",
            "type":"string"
        },
        "bsContactFunctionCode":{
            "description":"The contact name function code from the tracking event.",
            "type":"string"
        },
        "eventDate":{
            "description":"The event date and time reported on the tracking event.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "bsStatusCodeGid":{
            "description":"The status code identified on the tracking event.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"The service provider alias qualifier code, such as SCAC, from the entered tracking event.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"The service provide alias value from the tracking event.",
            "type":"string"
        },
        "timeZoneGid":{
            "description":"The time zone for the tracking event time entered.",
            "type":"string"
        },
        "statusLevel":{
            "description":"A descriptor code for the status level of the tracking event.",
            "type":"string"
        },
        "description":{
            "description":"A description of the tracking event.",
            "type":"string"
        },
        "obRefnumQualGid":{
            "description":"The order base reference number value associated with the order release qualifier that came on the tracking event.",
            "type":"string"
        },
        "obRefnumValue":{
            "description":"The order base reference number qualifier identifier.",
            "type":"string"
        },
        "bsReasonCodeGid":{
            "description":"The reason code from the tracking event that was matched to the order base.",
            "type":"string"
        },
        "bsResponsiblePartyGid":{
            "description":"The responsible party identifier of the source of the tracking event.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : eventDate

The event date and time reported on the tracking event.

Match All

The event date and time reported on the tracking event.

Show Source

• object dateTimeType

{
    "description":"The event date and time reported on the tracking event.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top