OrderShipping Data Type

Shipping details of a production order: recipient address, chosen carrier, and tracking number assigned after dispatch.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the OrderShipping.
title string The title of the shipping method.
price number The price of this shipping method.
codPrice number Total collect on delivery (COD) amount.
orderValue number The order value.
carrier Carrier The shipping company.
OrderShipping (JSON) 
{
  "shippingLine" : {
    "id" : 12345,
    "title" : "...",
    "price" : 12345.0,
    "codPrice" : 12345.0,
    "orderValue" : 12345.0,
    "carrier" : {
      "id" : 12345,
      "name" : "UPS",
      "description" : "Standard domestic shipping method",
      "phoneRequired" : true,
      "moduleProvider" : {
        "id" : 12345,
        "name" : "Standard",
        "provider" : "ups",
        "serviceType" : "standard",
        "moduleType" : { }
      },
      "customProvider" : "...",
      "premium" : true,
      "emdorsement" : "...",
      "ddp" : true,
      "showTicketLogo" : true,
      "customApiUser" : "...",
      "customApiKey" : "...",
      "htmlTemplate" : "...",
      "mainCarrier" : { },
      "perProduct" : true
    }
  }
}