README.md

Orders

(Ecommerce.Orders)

Overview

Available Operations

• List - List Orders
• Get - Get Order

List

List Orders

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/components"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.Ecommerce.Orders.List(ctx, operations.EcommerceOrdersAllRequest{
        ServiceID: sdkgo.String("salesforce"),
        Filter: &components.EcommerceOrdersFilter{
            Email: sdkgo.String("[email protected]"),
            CustomerID: sdkgo.String("123"),
            UpdatedSince: sdkgo.String("2020-09-30T07:43:32.000Z"),
            CreatedSince: sdkgo.String("2020-09-30T07:43:32.000Z"),
        },
        Sort: &components.OrdersSort{
            By: components.OrdersSortByCreatedAt.ToPointer(),
        },
        PassThrough: map[string]any{
            "search": "San Francisco",
        },
        Fields: sdkgo.String("id,updated_at"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetEcommerceOrdersResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.EcommerceOrdersAllRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.EcommerceOrdersAllResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	*/*

Get

Get Order

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.Ecommerce.Orders.Get(ctx, operations.EcommerceOrdersOneRequest{
        ID: "<id>",
        ServiceID: sdkgo.String("salesforce"),
        Fields: sdkgo.String("id,updated_at"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetEcommerceOrderResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.EcommerceOrdersOneRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.EcommerceOrdersOneResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	*/*