CM1 Shipment documentation

Associations

  1. Carrier carrier

    Choose from
    Carriers
    Default identifier
    name
    Example
    http://impact.brighterplanet.com/shipments?carrier=FedEx
    Example
    http://impact.brighterplanet.com/shipments?carrier[name]=FedEx

  2. Mode mode

    Choose from
    Modes
    Default identifier
    name
    Example
    http://impact.brighterplanet.com/shipments?mode=air
    Example
    http://impact.brighterplanet.com/shipments?mode[name]=air

Attributes

  1. Destination destination

    Accepts
    String
    Example
    http://impact.brighterplanet.com/shipments?destination=…

  2. Destination zip code destination_zip_code

    Accepts
    String
    Example
    http://impact.brighterplanet.com/shipments?destination_zip_code=…

  3. Distance distance

    Accepts
    Float
    Measures
    Kilometres
    Example
    http://impact.brighterplanet.com/shipments?distance=…

  4. Origin origin

    Accepts
    String
    Example
    http://impact.brighterplanet.com/shipments?origin=…

  5. Origin zip code origin_zip_code

    Accepts
    String
    Example
    http://impact.brighterplanet.com/shipments?origin_zip_code=…

  6. Package count package_count

    Accepts
    Integer
    Example
    http://impact.brighterplanet.com/shipments?package_count=…

  7. Segment count segment_count

    Accepts
    Integer
    Example
    http://impact.brighterplanet.com/shipments?segment_count=…

  8. Weight weight

    Accepts
    Float
    Measures
    Kilograms
    Example
    http://impact.brighterplanet.com/shipments?weight=…