Skip to content

Add GetOrderShipments #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alcwhite wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add GetOrderShipments #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1206,6 +1206,32 @@ type OrderShippingAddress struct {
}
```

#### type OrderShipment

```go
type OrderShipment struct {
ID int64 `json:"id"`
OrderID int64 `json:"order_id"`
CustomerID int64 `json:"customer_id"`
OrderAddressID int64 `json:"order_address_id"`
DateCreated string `json:"date_created"`
TrackingNumber string `json:"tracking_number"`
MerchantShippingCost string `json:"merchant_shipping_cost"`
ShippingMethod string `json:"shipping_method"`
Comments string `json:"comments"`
ShippingProvider string `json:"shipping_provider"`
TrackingCarrier string `json:"tracking_carrier"`
TrackingLink string `json:"tracking_link"`
BillingAddress Address `json:"billing_address"`
ShippingAddress Address `json:"shipping_address"`
Items []struct {
OrderProductID int64 `json:"order_product_id"`
ProductID int64 `json:"product_id"`
Quantity int `json:"quantity"`
} `json:"items"`
}
```


#### type Pagination

Expand Down
46 changes: 46 additions & 0 deletions orders.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,28 @@ type OrderCoupon struct {
Discount int `json:"discount"`
}

type OrderShipment struct {
ID int64 `json:"id"`
OrderID int64 `json:"order_id"`
CustomerID int64 `json:"customer_id"`
OrderAddressID int64 `json:"order_address_id"`
DateCreated string `json:"date_created"`
TrackingNumber string `json:"tracking_number"`
MerchantShippingCost string `json:"merchant_shipping_cost"`
ShippingMethod string `json:"shipping_method"`
Comments string `json:"comments"`
ShippingProvider string `json:"shipping_provider"`
TrackingCarrier string `json:"tracking_carrier"`
TrackingLink string `json:"tracking_link"`
BillingAddress Address `json:"billing_address"`
ShippingAddress Address `json:"shipping_address"`
Items []struct {
OrderProductID int64 `json:"order_product_id"`
ProductID int64 `json:"product_id"`
Quantity int `json:"quantity"`
} `json:"items"`
}

// GetOrders returns all orders using filters
// filters: request query parameters for BigCommerce orders endpoint, for example {"customer_id": "41"}
func (bc *Client) GetOrders(filters map[string]string) ([]Order, error) {
Expand Down Expand Up @@ -364,3 +386,27 @@ func (bc *Client) GetOrderCoupons(orderID int64) ([]OrderCoupon, error) {
}
return coupons, nil
}

// GetOrderShipments returns all shipments for a given order
func (bc *Client) GetOrderShipments(orderID int64) ([]OrderShipment, error) {
url := "/v2/orders/" + strconv.FormatInt(orderID, 10) + "/shipments"

req := bc.getAPIRequest(http.MethodGet, url, nil)
res, err := bc.HTTPClient.Do(req)
if err != nil {
return nil, err
}

defer res.Body.Close()
body, err := processBody(res)
if err != nil {
return nil, err
}

var shipments []OrderShipment
err = json.Unmarshal(body, &shipments)
if err != nil {
return nil, err
}
return shipments, nil
}