POST api/shipcarriershipment
Save ShipCarrierShipment
Request Information
URI Parameters
None.
Body Parameters
ShipCarrierShipment| Name | Type | Description | Additional information | 
|---|---|---|---|
| ShipCarrierShipmentId | integer | 
                             
  | 
                |
| ShipCarrierName | string | 
                             
  | 
                |
| ShipCarrierServiceName | string | 
                             
  | 
                |
| ShippingLicensePlate | string | 
                             
  | 
                |
| ShipDate | date | 
                             
  | 
                |
| TrackingNumber | string | 
                             
  | 
                |
| CarrierTransactionNumber | string | 
                             
  | 
                |
| TransactionDateTime | date | 
                             
  | 
                |
| Zone | string | 
                             
  | 
                |
| TotalCost | decimal number | 
                             
  | 
                |
| PartnerTotalCost | decimal number | 
                             
  | 
                |
| CarrierTotalCost | decimal number | 
                             
  | 
                |
| PackageTypeName | string | 
                             
  | 
                |
| FromPostalCode | string | 
                             
  | 
                |
| FromCountry | string | 
                             
  | 
                |
| ToAddress1 | string | 
                             
  | 
                |
| ToAddress2 | string | 
                             
  | 
                |
| ToCity | string | 
                             
  | 
                |
| ToState | string | 
                             
  | 
                |
| ToPostalCode | string | 
                             
  | 
                |
| ToCountry | string | 
                             
  | 
                |
| ReturnPostalCode | string | 
                             
  | 
                |
| SubClientName | string | 
                             
  | 
                |
| EstimatedDeliveryDate | date | 
                             
  | 
                |
| DeliveryDate | date | 
                             
  | 
                |
| CarrierReceivedDate | date | 
                             
  | 
                |
| AttemptedDeliveryDate | date | 
                             
  | 
                |
| InternalTransactionNumber | globally unique identifier | 
                             
  | 
                |
| IntegratorCode | string | 
                             
  | 
                |
| ReferenceNumber1 | string | 
                             
  | 
                |
| ReferenceNumber2 | string | 
                             
  | 
                |
| PaymentType | string | 
                             
  | 
                |
| UserName | string | 
                             
  | 
                |
| CreatedDate | date | 
                             
  | 
                |
| ModifiedDate | date | 
                             
  | 
                |
| ShipCarrierShipmentAdditionalDocuments | Collection of ShipCarrierShipmentAdditionalDocument | 
                             
  | 
                |
| ShipCarrierShipmentCharges | Collection of ShipCarrierShipmentCharge | 
                             
  | 
                |
| ShipCarrierShipmentpackageLabels | Collection of ShipCarrierShipmentPackageLabel | 
                             
  | 
                |
| ShipCarrierShipmentOptions | Collection of ShipCarrierShipmentOption | 
                             
  | 
                |
| ShipCarrierShipmentPackages | Collection of ShipCarrierShipmentPackage | 
                             
  | 
                |
| PerformanceInMS | integer | 
                             
  | 
                |
| ClientName | string | 
                             
  | 
                
Request Formats
application/json
            Sample:
    
        Sample not available.
text/json
            Sample:
    
        Sample not available.
application/xml
            Sample:
    
        Sample not available.
text/xml
            Sample:
    
        Sample not available.
application/x-www-form-urlencoded
            Sample:
    
Sample not available.
Response Information
Resource Description
ShipCarrierShipment| Name | Type | Description | Additional information | 
|---|---|---|---|
| ShipCarrierShipmentId | integer | 
                             
  | 
                |
| ShipCarrierName | string | 
                             
  | 
                |
| ShipCarrierServiceName | string | 
                             
  | 
                |
| ShippingLicensePlate | string | 
                             
  | 
                |
| ShipDate | date | 
                             
  | 
                |
| TrackingNumber | string | 
                             
  | 
                |
| CarrierTransactionNumber | string | 
                             
  | 
                |
| TransactionDateTime | date | 
                             
  | 
                |
| Zone | string | 
                             
  | 
                |
| TotalCost | decimal number | 
                             
  | 
                |
| PartnerTotalCost | decimal number | 
                             
  | 
                |
| CarrierTotalCost | decimal number | 
                             
  | 
                |
| PackageTypeName | string | 
                             
  | 
                |
| FromPostalCode | string | 
                             
  | 
                |
| FromCountry | string | 
                             
  | 
                |
| ToAddress1 | string | 
                             
  | 
                |
| ToAddress2 | string | 
                             
  | 
                |
| ToCity | string | 
                             
  | 
                |
| ToState | string | 
                             
  | 
                |
| ToPostalCode | string | 
                             
  | 
                |
| ToCountry | string | 
                             
  | 
                |
| ReturnPostalCode | string | 
                             
  | 
                |
| SubClientName | string | 
                             
  | 
                |
| EstimatedDeliveryDate | date | 
                             
  | 
                |
| DeliveryDate | date | 
                             
  | 
                |
| CarrierReceivedDate | date | 
                             
  | 
                |
| AttemptedDeliveryDate | date | 
                             
  | 
                |
| InternalTransactionNumber | globally unique identifier | 
                             
  | 
                |
| IntegratorCode | string | 
                             
  | 
                |
| ReferenceNumber1 | string | 
                             
  | 
                |
| ReferenceNumber2 | string | 
                             
  | 
                |
| PaymentType | string | 
                             
  | 
                |
| UserName | string | 
                             
  | 
                |
| CreatedDate | date | 
                             
  | 
                |
| ModifiedDate | date | 
                             
  | 
                |
| ShipCarrierShipmentAdditionalDocuments | Collection of ShipCarrierShipmentAdditionalDocument | 
                             
  | 
                |
| ShipCarrierShipmentCharges | Collection of ShipCarrierShipmentCharge | 
                             
  | 
                |
| ShipCarrierShipmentpackageLabels | Collection of ShipCarrierShipmentPackageLabel | 
                             
  | 
                |
| ShipCarrierShipmentOptions | Collection of ShipCarrierShipmentOption | 
                             
  | 
                |
| ShipCarrierShipmentPackages | Collection of ShipCarrierShipmentPackage | 
                             
  | 
                |
| PerformanceInMS | integer | 
                             
  | 
                |
| ClientName | string | 
                             
  | 
                
Response Formats
application/json
            Sample:
    
        Sample not available.
text/json
            Sample:
    
        Sample not available.
application/xml
            Sample:
    
        Sample not available.
text/xml
            Sample:
    
Sample not available.