README.md

Orders

(orders())

Overview

An order is a request from a customer to purchase goods from a merchant. Use the orders object to load orders from your system to the Shippo dashboard. You can use the orders object to create, retrieve, list, and manage orders programmatically. You can also retrieve shipping rates, purchase labels, and track shipments for each order.

Line Item

Line Items, and their corresponding abstract Products and Variants, might be exposed as a separate resource in the future. Currently it's a nested object within the order resource.

A line item is an individual object in an order. For example, if your order contains a t-shirt, shorts, and a jacket, each item is represented by a line item.

Available Operations

• list - List all orders
• create - Create a new order
• get - Retrieve an order

list

Returns a list of all order objects.

Example Usage

package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.OrderShopAppEnum;
import com.goshippo.shippo_sdk.models.components.OrderStatusEnum;
import com.goshippo.shippo_sdk.models.operations.ListOrdersRequest;
import com.goshippo.shippo_sdk.models.operations.ListOrdersResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        Shippo sdk = Shippo.builder()
                .apiKeyHeader("<YOUR_API_KEY_HERE>")
                .shippoApiVersion("2018-02-08")
            .build();

        ListOrdersRequest req = ListOrdersRequest.builder()
                .orderStatus(List.of(
                    OrderStatusEnum.PAID))
                .shopApp(OrderShopAppEnum.SHIPPO)
                .build();

        ListOrdersResponse res = sdk.orders().list()
                .request(req)
                .call();

        if (res.orderPaginatedList().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	ListOrdersRequest	✔️	The request object to use for the request.

Response

ListOrdersResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

create

Creates a new order object.

Example Usage

package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.AddressCreateRequest;
import com.goshippo.shippo_sdk.models.components.LineItemBase;
import com.goshippo.shippo_sdk.models.components.OrderCreateRequest;
import com.goshippo.shippo_sdk.models.components.OrderStatusEnum;
import com.goshippo.shippo_sdk.models.components.WeightUnitEnum;
import com.goshippo.shippo_sdk.models.operations.CreateOrderResponse;
import java.lang.Exception;
import java.time.OffsetDateTime;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        Shippo sdk = Shippo.builder()
                .apiKeyHeader("<YOUR_API_KEY_HERE>")
                .shippoApiVersion("2018-02-08")
            .build();

        CreateOrderResponse res = sdk.orders().create()
                .shippoApiVersion("2018-02-08")
                .orderCreateRequest(OrderCreateRequest.builder()
                    .placedAt("2016-09-23T01:28:12Z")
                    .toAddress(AddressCreateRequest.builder()
                        .country("US")
                        .name("Shwan Ippotle")
                        .company("Shippo")
                        .street1("215 Clayton St.")
                        .street3("")
                        .streetNo("")
                        .city("San Francisco")
                        .state("CA")
                        .zip("94117")
                        .phone("+1 555 341 9393")
                        .email("[email protected]")
                        .isResidential(true)
                        .metadata("Customer ID 123456")
                        .validate(true)
                        .build())
                    .currency("USD")
                    .notes("This customer is a VIP")
                    .orderNumber("#1068")
                    .orderStatus(OrderStatusEnum.PAID)
                    .shippingCost("12.83")
                    .shippingCostCurrency("USD")
                    .shippingMethod("USPS First Class Package")
                    .subtotalPrice("12.1")
                    .totalPrice("24.93")
                    .totalTax("0.0")
                    .weight("0.4")
                    .weightUnit(WeightUnitEnum.LB)
                    .fromAddress(AddressCreateRequest.builder()
                        .country("US")
                        .name("Shwan Ippotle")
                        .company("Shippo")
                        .street1("215 Clayton St.")
                        .street3("")
                        .streetNo("")
                        .city("San Francisco")
                        .state("CA")
                        .zip("94117")
                        .phone("+1 555 341 9393")
                        .email("[email protected]")
                        .isResidential(true)
                        .metadata("Customer ID 123456")
                        .validate(true)
                        .build())
                    .lineItems(List.of(
                        LineItemBase.builder()
                            .currency("USD")
                            .manufactureCountry("US")
                            .maxDeliveryTime(OffsetDateTime.parse("2016-07-23T00:00:00Z"))
                            .maxShipTime(OffsetDateTime.parse("2016-07-23T00:00:00Z"))
                            .quantity(20L)
                            .sku("HM-123")
                            .title("Hippo Magazines")
                            .totalPrice("12.1")
                            .variantTitle("June Edition")
                            .weight("0.4")
                            .weightUnit(WeightUnitEnum.LB)
                            .build()))
                    .build())
                .call();

        if (res.order().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
shippoApiVersion	Optional<String>	➖	Optional string used to pick a non-default API version to use. See our API version guide.	2018-02-08
orderCreateRequest	OrderCreateRequest	✔️	Order details.

Response

CreateOrderResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

get

Retrieves an existing order using an object ID.

Example Usage

package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.operations.GetOrderResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Shippo sdk = Shippo.builder()
                .apiKeyHeader("<YOUR_API_KEY_HERE>")
                .shippoApiVersion("2018-02-08")
            .build();

        GetOrderResponse res = sdk.orders().get()
                .orderId("<id>")
                .shippoApiVersion("2018-02-08")
                .call();

        if (res.order().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
orderId	String	✔️	Object ID of the order
shippoApiVersion	Optional<String>	➖	Optional string used to pick a non-default API version to use. See our API version guide.	2018-02-08

Response

GetOrderResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*