Sign in



Ship Help

Search Ship Help

Overview of the GetShipAdvise Options

Avatar
Simon Schrader Springer
Updated

This article is aimed at developers looking to use the method GetShipAdvise.
In order to get a list of valid products returned from Shipment Server.

Note: This article only highlights the different options that can be used on the method.
You need to apply your own business flow, logic, and error handling.

 

Content in this article:

 

Note: You can use the Developer Tools to test the requests.

 

GetShipAdvise

The method will return the Products that can pass the CSR validations and if requested with the RequiredDeliveryDate option, delivered within a certain date.

Note: Both the Shipping Rules and the Carrier Performance configuration are normally configured by a technical consultant from nShift.

 

Options that can be used with the method: 

 

Getting a list of valid products

{
    "ServiceLevel": "Service_Level_Configured_For_ShipAdvisor",
}

 All valid products will be returned without any price or ETA information. 

 

Getting a list of valid products with prices

{
    "ServiceLevel": "Service_Level_Configured_For_ShipAdvisor",
    "Price": "fixed"
}

The price key can also be configured with:

  • "1" - Will call CPC and use the Price1 returned.
  • "2" - Will call CPC and use the Price2 returned.
  • "fixed" - Will use the Price configured on the product in the CSR configuration file using the Price node.

 

Getting a list of valid products with ETA

{
    "ServiceLevel": "Service_Level_Configured_For_ShipAdvisor",
    "Deliverydate": "ETAWS"
}

Both products that contain an ETA and without will be returned.

Note: This requires defining a config file containing the agreed delivery time with your carrier. 
Contact nShift customer service if this is needed.

 

Getting a list of valid products which can be delivered within a date

{
    "ServiceLevel": "Service_Level_Configured_For_ShipAdvisor",
    "RequiredDeliveryDate": "2019-09-10"
}

Only products that can be delivered before the RequiredDeliveryDate will be returned.
Products that are not configured with ETA will also be filtered out.

The date needs to be in the ISO 8601 format "yyyymmdd" the time will be added automatically.
So the date above will be seen as 2019-09-10T23:59:00

Note: This requires defining a config file containing the agreed delivery time and the scheduled pickup with your carrier. Contact nShift customer service if this is needed.

 

Data

You should only have information regarding the shipment in the request. Anything regarding services, goods types, or product id should not be included.

{
  "Addresses": [
    {
      "Kind": 1,
      "Name1": "Name1 - Receiver",
      "Street1": "Test address 1",
      "PostCode": "7400",
      "City": "Herning",
      "CountryCode": "DK",
      "Email": "noreply@nshift.com"
    }
  ],
  "Lines": [
    {
      "PkgWeight": 1000,
      "Number": 1
    }
  ]
}

See this article here for basic examples of the Data object or use the Developer Tools to construct it.

For more advanced usage you need to use the Shipment Server - Appendix

Related articles