GET lookup/getAddressBookRules?companyId={companyId}

Returns the Address Book Rules against a company id

Pass HTTP Authorization request header with value "Bearer {token}" to perform this action

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

string
Required

Body Parameters

None.

Response Information

Resource Description

List of company Addresses

AdressBookRulesResponse
NameDescriptionTypeAdditional information
Data

AddressBookRulesDto

None.

Code

Response code returned by api

HttpStatusCode

None.

Message

Human readable message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Address": {
      "CompanyId": "sample string 1",
      "StoreNumber": "sample string 2",
      "Company": "sample string 3",
      "AttentionTo": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "State": "sample string 8",
      "Zip": "sample string 9",
      "Country": "sample string 10",
      "Phone": "sample string 11",
      "Extension": "sample string 12",
      "Email": "sample string 13",
      "AddressValidated": true,
      "LogoPath": "sample string 15"
    },
    "AdditionalInfo": {
      "Notes": "sample string 1",
      "OpenTime": "sample string 2",
      "CloseTime": "sample string 3",
      "TaxIDNumber": "sample string 4",
      "UserDefinedField1": "sample string 5",
      "UserDefinedField2": "sample string 6",
      "UserDefinedField3": "sample string 7",
      "UserDefinedField4": "sample string 8",
      "UserDefinedField5": "sample string 9",
      "UserDefinedField6": "sample string 10",
      "DestinationAirportCode": "sample string 11",
      "DestinationOceanPortCode": "sample string 12"
    },
    "Options": {
      "InternationalCustomsBroker": true,
      "DefaultCustomsBroker": true,
      "IsResidentialDelivery": true,
      "DefaultAddress": true,
      "UseEmailOnBOL": true,
      "AddCustomerLogoAllDocs": true,
      "isCustomerVendor": true,
      "VendorEEIFiling": true,
      "UseAsSoldTo": true
    },
    "UCCLabels": {
      "IsUCC": true,
      "UCCLabelType": "sample string 2",
      "UPC": true,
      "OrderNumber": true,
      "ItemNumber": true,
      "ItemDescription": true,
      "ItemWeight": true,
      "SKU": true,
      "Category": true,
      "UserDefinedField1": true,
      "UserDefinedField2": true,
      "UserDefinedField3": true,
      "CustomerItemNumber": true
    },
    "PoolingRates": {
      "IsPoolingPointAddress": true,
      "PerShipmentCrossDockFee": "sample string 2",
      "AddtlPerLbsFee": "sample string 3",
      "StorageDaysIncluded": "sample string 4",
      "PerShipmentStorageCostAfterFreeDays": "sample string 5"
    },
    "Rules": {
      "RestrictedCarriers": [
        {
          "CompanyCarrierId": 1,
          "CarrierName": "sample string 2",
          "CarrierNickName": "sample string 3"
        },
        {
          "CompanyCarrierId": 1,
          "CarrierName": "sample string 2",
          "CarrierNickName": "sample string 3"
        }
      ],
      "DefaultOriginAccessorials": [
        "sample string 1",
        "sample string 2"
      ],
      "DefaultDestinationAccessorials": [
        "sample string 1",
        "sample string 2"
      ],
      "DeliveryConfirmation": "sample string 1",
      "EnablePackingSlip": true,
      "ShippingModes": [
        "sample string 1",
        "sample string 2"
      ],
      "PackingSlipType": "sample string 3",
      "DefaultPickupInstructions": "sample string 4",
      "DefaultDeliveryInstructions": "sample string 5",
      "DefaultPayeeApplyOn": "sample string 6",
      "DefaultPayee": "sample string 7",
      "AllowMixingAutoCalc": true,
      "DefaultCompanyCarrierId": 9,
      "DefaultCarrierName": "sample string 10",
      "DefaultCarrierNickName": "sample string 11",
      "CoefficientAddendum": true
    },
    "ShippingAccounts": [
      {
        "CompanyCarrierId": 1,
        "CarrierName": "sample string 2",
        "CarrierNickName": "sample string 3",
        "Company": "sample string 4",
        "Street": "sample string 5",
        "City": "sample string 6",
        "State": "sample string 7",
        "Zip": "sample string 8",
        "Country": "sample string 9",
        "Phone": "sample string 10",
        "Email": "sample string 11",
        "AccountNumber": "sample string 12",
        "Image": "sample string 13"
      },
      {
        "CompanyCarrierId": 1,
        "CarrierName": "sample string 2",
        "CarrierNickName": "sample string 3",
        "Company": "sample string 4",
        "Street": "sample string 5",
        "City": "sample string 6",
        "State": "sample string 7",
        "Zip": "sample string 8",
        "Country": "sample string 9",
        "Phone": "sample string 10",
        "Email": "sample string 11",
        "AccountNumber": "sample string 12",
        "Image": "sample string 13"
      }
    ],
    "MarkupDetails": [
      {
        "MarkUpSpecification": "sample string 1",
        "MarkUpType": "sample string 2",
        "MarkUpValue": 3.0,
        "CompanyCarrierId": 1,
        "CarrierName": "sample string 4",
        "CarrierNickName": "sample string 5",
        "ServiceId": 1,
        "ServiceName": "sample string 6",
        "ShowMarkup": true,
        "HideMarkupInternally": true
      },
      {
        "MarkUpSpecification": "sample string 1",
        "MarkUpType": "sample string 2",
        "MarkUpValue": 3.0,
        "CompanyCarrierId": 1,
        "CarrierName": "sample string 4",
        "CarrierNickName": "sample string 5",
        "ServiceId": 1,
        "ServiceName": "sample string 6",
        "ShowMarkup": true,
        "HideMarkupInternally": true
      }
    ],
    "CustomerLevelFees": [
      {
        "FeeType": 1,
        "MinimumRate": 2.1,
        "MinLimit": 3,
        "MaxLimit": 4,
        "Rate": 5.1,
        "IsFlatFee": true
      },
      {
        "FeeType": 1,
        "MinimumRate": 2.1,
        "MinLimit": 3,
        "MaxLimit": 4,
        "Rate": 5.1,
        "IsFlatFee": true
      }
    ],
    "BOLSOPPrintAsAttachmentOnBOL": true,
    "BOLSOPBody": "sample string 2"
  },
  "Code": 100,
  "Message": "sample string 1"
}