Easy Post Integration

Explore how Frank and Oak utilizes the Easy Post integration within the OMS for streamlined shipping processes, including configuration details and API usage.

Frank and Oak uses the Easy Post integration offered by the OMS. This document details the paramaters configured specifically for Frank and Oak. To learn more about the full integration, along with field mappings, checkout the full integration document here.

How Easy Post is configured in Frank and Oak:

1. Canada Post (CPC) - Regular Domestic Shipping (Canada):

   • Facilitates standard domestic shipping within Canada.

2. UPS - Regular Shipping to the US:

   • Utilized for standard shipping to destinations in the United States.

3. Canada Post (CPC) - Express Domestic Shipping (Canada):

   • Enables expedited domestic shipping within Canada.

4. UPS - Express Shipping to the US:

   • Supports expedited shipping to destinations in the United States.

Additional Requirements:

• PO Box Shipping:

  • CPC is designated for shipping to PO boxes. All shipments to PO boxes must be processed through CPC.

• International Shipping from Stores (Excluding CA/US):

  • International shipping from stores to countries other than Canada and the United States will be disabled (refer to the configurations page).

Configuration Responsibilities:

• EasyPost manages the integration with shipping providers.

• CPC is specifically designated for PO box shipping and express domestic shipping within Canada.

• UPS is engaged for regular and express shipping to the US.

Create a Shipment API

Purpose:

The Create a Shipment API is utilized to share all necessary details of a shipment with EasyPost. This includes shipment information such as package dimensions, weight, origin, and destination. In return, the API fetches rates available from different carriers for shipping the specified package.

Method

POST

https://api.easypost.com/v2/shipments

Request:

The postage_label is configured for Frank and Oak to 4 x 6. In cases where specific values are not provided, Easy Post will return its default label size.

Sample request

{
  "origin": {
    "address": "735 Queen St W",
    "city": "Anytown",
    "state": "CA",
    "zip": "12345"
  },
  "destination": {
    "address": "456 Oak St",
    "city": "Another Town",
    "state": "NY",
    "zip": "67890"
  },
  "package": {
    "weight": 2.5,
    "dimensions": {
      "length": 10,
      "width": 8,
      "height": 5
    }
  },
  "postage_label": {
    "label_format": "PNG",
    "label_size": "4x6"
  }
}

Response:

The response is not handled with any exceptoins for Frank and Oak at this time.

Buy a Shipment API

Frank and Oak only uses one carrier for each country, Canada and the United States, so the rate shopping function automatically selects the lowest cost option returned by the carrier and generates the label for the fulfillment team.

For facility specific carrier account IDs, we need to import the below added data, without it the shipping labels will default to Canada Post:

<FacilityAttribute facilityId="CLVST" attrName="CARRIER_ACCOUNTS" attrValue="ca_3b4eac328c544c8995974d7585f881f5"/>
<FacilityAttribute facilityId="DIXST" attrName="CARRIER_ACCOUNTS" attrValue="ca_50d68dc2a9a94528b71e367f004512fe"/>
<FacilityAttribute facilityId="DONST" attrName="CARRIER_ACCOUNTS" attrValue="ca_a9459b96af6d46d58af5ed8b77147cec"/>
<FacilityAttribute facilityId="FOYST" attrName="CARRIER_ACCOUNTS" attrValue="ca_fbb9b2700aeb4afea6848ff71fc2502f"/>
<FacilityAttribute facilityId="FPCST" attrName="CARRIER_ACCOUNTS" attrValue="ca_93bb427be6de40769987bf8dd9530405"/>
<FacilityAttribute facilityId="HALST" attrName="CARRIER_ACCOUNTS" attrValue="ca_4393721c708a4be9b49f661f39309830"/>
<FacilityAttribute facilityId="KITST" attrName="CARRIER_ACCOUNTS" attrValue="ca_3d6f73970410430aae4ec944080327cc"/>
<FacilityAttribute facilityId="MTLST" attrName="CARRIER_ACCOUNTS" attrValue="ca_b6625dcaf3304eec8455fcf96ded7f9a"/>
<FacilityAttribute facilityId="RIDST" attrName="CARRIER_ACCOUNTS" attrValue="ca_21b9fe5380cd4cc28cf3273d0d6ea4ae"/>
<FacilityAttribute facilityId="SQOST" attrName="CARRIER_ACCOUNTS" attrValue="ca_50a709534e414a60bda0cd32b23ced8e"/>
<FacilityAttribute facilityId="STANST" attrName="CARRIER_ACCOUNTS" attrValue="ca_5e8d38f2c14d440083c0f8e271656724"/>
<FacilityAttribute facilityId="STWST" attrName="CARRIER_ACCOUNTS" attrValue="ca_a8224a64df0f4bc6b87fbb868aa49425"/>
<FacilityAttribute facilityId="TECST" attrName="CARRIER_ACCOUNTS" attrValue="ca_f35eea517540457a953f43f986e619dd"/>
<FacilityAttribute facilityId="TOST" attrName="CARRIER_ACCOUNTS" attrValue="ca_1980d579aed84abdb7ac112e9b98c344"/>
<FacilityAttribute facilityId="VIAST" attrName="CARRIER_ACCOUNTS" attrValue="ca_51460ba6e703417ba3c3d8a900d3de51"/>
<FacilityAttribute facilityId="VANST" attrName="CARRIER_ACCOUNTS" attrValue="ca_faf342ba506b43d6ada2d9cc2011ea71"/>