Shipping Preferences API

https://test.valorebooks.com/buyer/shippinginfo (qa)
https://api.valorebooks.com/buyer/shippinginfo (production)

POST Set your shipping preferences

Parameters

Name	Located in	Description	Type
Content-Type	header		String
receivingInformation	body	Contains shipping address and contact information	Object
shippingAddress	receivingInformation	Contains shipping address information	Object
name	shippingAddress	Name of shipping address	String
line1	shippingAddress	50 character maximum first line of shipping address	String
line2	shippingAddress	Second line of shipping address	String
city	shippingAddress	City of shipping address	String
state	shippingAddress	Two letter USA or CAN state/province abbreviation of shipping address (e.g. MA, BC)	String
country	shippingAddress	USA or CAN (defaults to USA if not already set and not included in request)	String
postalCode	shippingAddress	USA or CAN postal code of shipping address (e.g. 02210, 02210-1014, or R3T 2N2)	String
hasLoadingDock	shippingAddress	YES, NO, or NOT_SURE (case-insensitive)	String
contact	receivingInformation	Contains contact information	Object
name	contact	Name of contact	String
email	contact	Email address of contact	String
phone	contact	10 digit phone number of contact (3125550101)	String
shippingPreferences	body	Contains shipment frequency, notes, and freight and/or parcel carrier info	Object
shipmentFrequency	shippingPreferences	Weekly, Pallet, or Scheduled	String
freightCarrier	shippingPreferences	Contains freight carrier information (optional if parcelCarrier is provided)	Object
parcelCarrier	shippingPreferences	Contains parcel carrier information (optional if freightCarrier is provided)	Object
carrierName	freightCarrier or parcelCarrier	FedEx, USPS, UPS, DHL, or a 50 character maximum custom carrier name	String
accountNumber	freightCarrier or parcelCarrier	Your 50 character maximum carrier account number	String
contact	freightCarrier or parcelCarrier	Contains carrier contact information (Required for custom carriers only)	Object
name	contact	The 50 character maximum name of the carrier contact (Required for custom carriers only)	String
email	contact	The 50 character maximum email of the carrier contact (Required for custom carriers only)	String
phone	contact	The 50 character maximum phone number of the carrier contact (Required for custom carriers only)	String
notes	shippingPreferences	Additional notes about shipping preferences (Required when both parcelCarrier and freightCarrier are provided)	String
shipmentDate	body	Day the shipment should arrive by, if not Weekly or Pallet (Format: YYYY-MM-dd, e.g. 2018-06-01)	Date

Request Examples

Creating the shipping preferences

{
  "receivingInformation": {
    "shippingAddress": {
      "name": "Follett Corporation",
      "line1": "256 Summer Street",
      "city": "Boston",
      "state": "MA",
      "postalCode": "02210",
      "hasLoadingDock": "YES"
    },
    "contact": {
      "name": "John Smith",
      "email": "john@follett.com",
      "phone": "5555555555"
    }
  },
  "shippingPreferences": {
    "shipmentFrequency": "Scheduled",
    "freightCarrier": {
      "carrierName": "FedEx",
      "accountNumber": "1234-5678"
    },
    "parcelCarrier": {
      "carrierName": "My Parcel Carrier",
      "accountNumber": "4321-8765",
      "contact": {
        "name": "Jane Doe",
        "email": "jane@myparcelcarrier.com",
        "phone": "5554443333"
      }
    },
    "notes": "Please contact Jane Doe 1 day prior to shipping with My Parcel Carrier."
  },
  "shipmentDate": "2018-05-31"
}

Updating the shipmentDate

{
  "shipmentDate": "2018-06-31"
}

Responses

200 Your shipping preferences have been set

400 There was an error with your request

Please enter a contact business name.
Please enter a valid contact email address.

500 An internal error occurred

403 Your AWS credentials are not correct

No buyer found with given credentials.