Skip to content

README.md

Latest commit

 

History

History
126 lines (94 loc) · 6.73 KB

README.md

File metadata and controls

126 lines (94 loc) · 6.73 KB
Raw

Ecommerce.Orders

Overview

Available Operations

  • List - List Orders
  • Get - Get Order

List

List Orders

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;
using System.Collections.Generic;

var sdk = new Apideck(
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    apiKey: "<YOUR_BEARER_TOKEN_HERE>"
);

EcommerceOrdersAllRequest req = new EcommerceOrdersAllRequest() {
    ServiceId = "salesforce",
    Filter = new EcommerceOrdersFilter() {
        Email = "elon@musk.com",
        CustomerId = "123",
        UpdatedSince = "2020-09-30T07:43:32.000Z",
        CreatedSince = "2020-09-30T07:43:32.000Z",
    },
    Sort = new OrdersSort() {
        By = OrdersSortBy.CreatedAt,
        Direction = SortDirection.Desc,
    },
    PassThrough = new Dictionary<string, object>() {
        { "search", "San Francisco" },
    },
    Fields = "id,updated_at",
};

EcommerceOrdersAllResponse? res = await sdk.Ecommerce.Orders.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

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

Response

EcommerceOrdersAllResponse

Errors

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

Get

Get Order

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
    apiKey: "<YOUR_BEARER_TOKEN_HERE>"
);

EcommerceOrdersOneRequest req = new EcommerceOrdersOneRequest() {
    Id = "<id>",
    ServiceId = "salesforce",
    Fields = "id,updated_at",
};

var res = await sdk.Ecommerce.Orders.GetAsync(req);

// handle response

Parameters

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

Response

EcommerceOrdersOneResponse

Errors

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