Skip to content

Incorrect Documentation #122

Description

@jamiehankins

The documentation here is incorrect.

The only thing worse than missing documentation is incorrect documentation.

I need to calculate rates for a shipment. I want rates for multiple carriers for a number of services. I can do this with your raw REST API. I can't for the life of me figure out how to do it with your .NET API, though.

Four years ago, when I needed to write an integration for ShipEngine, I wrote my own because of issues with your .NET API. Your API has matured and is much improved, or so I thought until I tried to write code to get a collection of quotes.

The first thing your documentation shows is this:

var calculateRatesRequestBody = new CalculateRatesRequestBody();

That class has no default constructor. The available constructors either want a RateShipmentRequest or RateIdRequest.

So if I create a RateShipmentRequest, it has a property called Shipment. However, Shipment is a AddressValidatingShipment. It requires a carrier ID and service code. That's clearly not the way to get a collection of quotes!

Using RateIdRequest is even more wrong, since it only takes a shipment ID and no other information. Do I have to create a shipment before?

Why did you deprecate GetRatesWithShipmentDetails() that clearly does do what we need?

I want to use your .NET SDK, but this is making it really hard. How is anyone using your .NET SDK unless I'm massively misunderstanding something?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions