Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Attribute

Description

Endpoint

https://postpurchase.fenixcommerce.com/fenix/oms/crs/v1/rateshopping/get-rateshopping-info

Method

POST

Headers

tenant_id

auth_token

Request Sample

Code Block
{
    "request_id":"cf0d52b7-c214-47b9-8bdf-ea4e30b4299d",
    "shipment_id":"#128992",expected_delivery_date": "string", 
    "expected_shipping_date": "string", 
    "from": {
        "address1": "string", 
        "address2": "string", 
        "city": "string", 
        "country": "string", 
        "phone": "string", 
        "residential": true, 
        "state": "string", 
        "timeZone": "string", 
        "zipcode": "string"
    }, 
    "order_id": "string", 
    "shipment_id": "string", 
    "original_destination": {
        "address1": "string", 
        "address2": "string", 
        "city": "string", 
        "country": "string", 
        "phone": "string", 
        "residential": true, 
        "state": "string", 
        "timeZone": "string", 
        "zipcode": "string"
    }, 
    "request_id": "string", 
    "shipment_info": {
        "dimensions": {
            "height": 0, 
            "length": 0, 
            "units": "string", 
            "width": 0
        }, 
        "package_name": "string", 
        "product_infos": [
            {
                "dimensions": {
                    "height": 0, 
                    "length": 0, 
                    "units": "string", 
                    "width": 0
                }, 
                "quantity": 0, 
                "sku": "string", 
                "weight": {
                    "units": "string", 
                    "value": 0
                }
            }
        ], 
        "shipping_method": "string", 
        "weight": {
            "units": "string", 
            "value": 0
        }
    }, 
    "to": {
        "address1": "string", 
        "address2": "string", 
        "city": "string", 
        "country": "string", 
        "id": "string", 
        "phone": "string", 
        "residential": true, 
        "state": "string", 
        "timeZone": "string", 
        "zipcode": "string"
    }, 
    "warehouse_id": "string", 
    "deliver_within_days": 0
}

Response

Code Block
{
    "request_id": "string", 
    "to": {
        "fname": "string", 
        "lname": "string", 
        "address1": "string", 
        "address2": "string", 
        "city": "string", 
        "country": "string", 
        "state": "string", 
        "zipcode": "string", 
        "residential": false, 
        "po_box": false
    }, 
    "from": {
        "fname": "string", 
        "lname": "string", 
        "address1": "string", 
        "address2": "string", 
        "city": "string", 
        "country": "string", 
        "state": "string", 
        "zipcode": "string", 
        "residential": false, 
        "po_box": false
    }, 
    "shipment_info": {
        "package_name": "string", 
        "dimensions": {
            "length": 0, 
            "width": 0, 
            "height": 0, 
            "units": "string"
        }, 
        "space_utilization": 0, 
        "weight": {
            "value": 0, 
            "units": "string"
        }, 
        "shipping_method": "string", 
        "billed_weight": {
            "value": 0, 
            "units": "string"
        }
    }, 
    "request_dt": "string", 
    "zone": "string", 
    "expected_delivery_date": "string", 
    "expected_shipping_date": "string", 
    "deliver_within_days": 0, 
    "expectederror_delivery_dateinfo": {
 "06-19-2023 08:30",       "error_code": "string", 
        "expectederror_shipping_datemessage": "06-13-2023 16:30string", 
        "fromdescription": "string"
{    }, 
    "address1suggested_service_responses": "210[
 rose ct",      {
  "address2": "",         "citycarrier": "campbell",string", 
            "countryservice": "US",
{
       "fname": "John",         "lnamecode": "Doestring", 
       "po_box": false,         "residentialname": false,"string"
        "state": "CA",      }, 
 "zipcode": "95008"     },     "referenceship_idcost": "Order_id_198",{
      "shipment_info": {         "dimensionsamount": { 0, 
                "heightcurrency": 10,"string"
            "length": 10,}, 
            "unitsbilled_weight": "IN", {
                "widthvalue": 100, 
       },         "package_nameunits": "string",

       "product_infos": null,     }, 
  "properties": null,         "shipmentshipping_cost_idbreakup": "#128992",{
          "weight": {     "base_price": {
      "units": "LB",             "valueamount": 0.10, 
          }     },     "tocurrency": {"string"
            "address1": "5434 castle manor dr"}, 
       "address2": "",         "citytotal_discount": "San jose",{
          "country": "US",         "fnameamount": "John",0, 
          "lname": "Doe",         "po_boxcurrency": false,
"string"
       "residential": true,         "state": "CA",  }, 
     "zipcode": "95129"     },     "warehousetotal_idtaxes": "" }

Response

Code Block
{
    "request_id": "cf0d52b7-c214-47b9-8bdf-ea4e30b4299d",     "to": {         "fnameamount": "John"0, 
        "lname": "Doe",            "address1currency": "string"
 "5434 castle manor dr",         "address2": "",  }, 
     "city": "San jose",         "countrytotal_ship_cost": "US",{
          "state": "CA",         "zipcodeamount": "95129",0, 
          "residential": true,          "currency": "po_box": falsestring"
         },     "from": { }, 
      "fname": "John",         "lnametotal_surcharges": "Doe",{
        "address1": "210 rose ct",         "address2amount": ""0, 
        "city": "campbell",            "countrycurrency": "USstring",
  
     "state": "CA",          "zipcode": "95008" }, 
       "residential": false,
        "po_boxtotal_duties_and_taxes": false {
         },     "request_dt": "2023-06-13T15:20:56.393701121Z",     "fenix_request_idamount": "90a994f8-f60f-4d8a-8038-781370d80c89",0, 
    "expected_delivery_date": "06-19-2023 08:30",         "expected_shipping_date": "06-13-2023 16:30",     "deliver_within_dayscurrency": 0,"string"
     "suggested_service_responses": [         { }, 
          "carrier": "USPS",     "surcharges": [
       "service": {            {
    "code": "First-Class Package Service",                 "name": null"string", 
           },             "ship_costcode": { "string", 
                        "amountdescription": 3.59"string", 
               "currency": "USD"          "amount": {
 },             "retail_ship_cost": null,             "transit_infoamount": {0, 
               "delivery_date": "06-16-2023 23:59",                 "transit_timecurrency": 3"string"
             },           }
 "ship_by_date": "06-16-2023 16:30",               "delivery_accuracy_percent": 0.0,  }, 
         "metainfo": {          {
      "included": true,                 "exclusion_codename": null"string", 
                "exclude_message": null        "code": "string", 
      }         }     ],    "description": "excluded_service_responses": ["string", 
           {             "carrieramount": "FEDEX",{
            "service": {                 "codeamount": "SMART_POST",0, 
                            "namecurrency": "SMART_POSTstring"
            },            }
"ship_cost": {                 "amount": 6.32, }
               "currency": "USD" ]
            }, 
            "retailtransit_ship_costinfo": null, {
                "transitshipping_infodate": {"string", 
                "delivery_date": "06-15-2023 16:30string", 
                "transit_time": 20
            }, 
            "ship_by_date": "06-16-2023 16:30string", 
            "delivery_accuracy_percent": 0.0, 
            "metainfo": {
                "included": falsetrue, 
                "exclusion_code": "SHIPPING_COSTstring", 
                "exclude_message": "Excluded due to ship coststring"
            }
        }
    ]
}

Request Attribute Definitions

...