Choose Brand API

Welcome to the API documentation for retrieving orders and updating tracking numbers using the Choose platform. This API allows the brand to fetch their orders from the Choose platform and subsequently update tracking numbers for those orders. Please read this notion https://choose.notion.site/Brand-Open-API-ae1867a30f1e4bff94ba550f3be642da for more information.

Contact

Choose Tech Support

tech@appchoose.io

License

Apache 2.0

https://www.apache.org/licenses/LICENSE-2.0.html

API Endpoints
https://brand.api.appchoose.io/graphql
Headers
# Your API token from the dashboard. Must be included in all API calls.
x-api-key: <YOUR_TOKEN_HERE>
Version

1.0.0

Queries

info

Description

Gets the system information

Response

Returns a SystemInfo!

Example

Query
query info {
  info {
    buildVersion
    version
    environment
  }
}
Response
{
  "data": {
    "info": {
      "buildVersion": "abc123",
      "version": "xyz789",
      "environment": "xyz789"
    }
  }
}
Queries

order

Description

Gets the order

Response

Returns an Order!

Arguments
Name Description
id - ID!

Example

Query
query order($id: ID!) {
  order(id: $id) {
    id
    billingId
    customerId
    sellerId
    saleId
    initialOrderId
    initialOrder {
      ...OrderFragment
    }
    reshipOrderId
    reshipOrder {
      ...OrderFragment
    }
    buyer {
      ...BuyerFragment
    }
    recipient {
      ...RecipientFragment
    }
    shipping {
      ...OrderShippingFragment
    }
    isShippingEstimatedTimeExceeded
    totalPriceSold {
      ...PriceFragment
    }
    items {
      ...ItemFragment
    }
    parcels {
      ...ParcelFragment
    }
    returnParcels {
      ...ReturnParcelFragment
    }
    returnSlips {
      ...ReturnSlipFragment
    }
    claims {
      ...ClaimFragment
    }
    linesRefunds {
      ...OrderLineRefundFragment
    }
    rating {
      ...OrderRatingFragment
    }
    integration {
      ...OrderIntegrationFragment
    }
    operationType
    payment {
      ...OrderPaymentFragment
    }
    hasBeenExported
    hasSellerError
    hasSynchronizationError
    isCancelled
    isFullDigital
    splitActionErrorReasons
    createdAt
    tags {
      ...OrderTagsFragment
    }
    tagging {
      ...OrderTaggingFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "order": {
      "id": "4",
      "billingId": 4,
      "customerId": "4",
      "sellerId": "4",
      "saleId": 4,
      "initialOrderId": 4,
      "initialOrder": Order,
      "reshipOrderId": 4,
      "reshipOrder": Order,
      "buyer": Buyer,
      "recipient": Recipient,
      "shipping": OrderShipping,
      "isShippingEstimatedTimeExceeded": true,
      "totalPriceSold": Price,
      "items": [Item],
      "parcels": [Parcel],
      "returnParcels": [ReturnParcel],
      "returnSlips": [ReturnSlip],
      "claims": [Claim],
      "linesRefunds": [OrderLineRefund],
      "rating": OrderRating,
      "integration": OrderIntegration,
      "operationType": "DROP_SHIPPING",
      "payment": OrderPayment,
      "hasBeenExported": true,
      "hasSellerError": true,
      "hasSynchronizationError": true,
      "isCancelled": true,
      "isFullDigital": false,
      "splitActionErrorReasons": ["ORDER_CANCELLED"],
      "createdAt": "2007-12-03T10:15:30Z",
      "tags": OrderTags,
      "tagging": OrderTagging
    }
  }
}
Queries

orders

Description

Gets the orders

Example :

query Orders($saleId: ID!, $input: OrdersInput!) {
    orders(saleId: $saleId, input: $input) {
        nodes {
            id
            sellerId
            saleId
            recipient {
                fullName
                firstName
                lastName
                address {
                    street
                    streetAdditional
                    zipCode
                    city
                    county
                    state
                    country
                    countryCode
                }
            }
            createdAt
        }
        paging {
            hasPreviousPage
            hasNextPage
            startCursor
            endCursor
            pageSize
        }
        totalCount
    }
}

{
    "saleId": "some_sale_id",
    "input": {
        "filter": {
            "tagging": {
                "fulfillment": "UNFULFILLED"
            }
        },
    "paging": {
        "pageSize": 50
    },
    "sort": {
        "field": "CREATION_DATE",
        "order": "ASCENDING"
    }
}
Response

Returns an Orders!

Arguments
Name Description
saleId - ID!
input - OrdersInput!

Example

Query
query orders(
  $saleId: ID!,
  $input: OrdersInput!
) {
  orders(
    saleId: $saleId,
    input: $input
  ) {
    nodes {
      ...OrderFragment
    }
    paging {
      ...PagingFragment
    }
    totalCount
  }
}
Variables
{
  "saleId": "4",
  "input": OrdersInput
}
Response
{
  "data": {
    "orders": {
      "nodes": [Order],
      "paging": Paging,
      "totalCount": PositiveInteger
    }
  }
}
Queries

ordersPaginated

Use orders instead
Description

Gets the orders of a sale

Response

Returns an OrdersConnection!

Arguments
Name Description
saleId - String!
input - OrdersPaginatedInput

Example

Query
query ordersPaginated(
  $saleId: String!,
  $input: OrdersPaginatedInput
) {
  ordersPaginated(
    saleId: $saleId,
    input: $input
  ) {
    nodes {
      ...OrderFragment
    }
    pageInfo {
      ...PageInfoConnectionFragment
    }
  }
}
Variables
{
  "saleId": "abc123",
  "input": OrdersPaginatedInput
}
Response
{
  "data": {
    "ordersPaginated": {
      "nodes": [Order],
      "pageInfo": PageInfoConnection
    }
  }
}

Mutations

createParcel

Description

Creates a parcel with some items on an order

Response

Returns a Void

Arguments
Name Description
orderId - String!
trackingInfo - ParcelTrackingInfo!
itemIds - [String!]

Example

Query
mutation createParcel(
  $orderId: String!,
  $trackingInfo: ParcelTrackingInfo!,
  $itemIds: [String!]
) {
  createParcel(
    orderId: $orderId,
    trackingInfo: $trackingInfo,
    itemIds: $itemIds
  )
}
Variables
{
  "orderId": "abc123",
  "trackingInfo": ParcelTrackingInfo,
  "itemIds": ["xyz789"]
}
Response
{"data": {"createParcel": null}}

Types

Address

Description

Address

Fields
Field Name Description
street - String! Street
streetAdditional - String Street additional
zipCode - String! Zip code
city - String! City
county - String County
state - String Letters indicating which state the address is from
country - String! Country
countryCode - String! Country code
Example
{
  "street": "abc123",
  "streetAdditional": "abc123",
  "zipCode": "abc123",
  "city": "abc123",
  "county": "xyz789",
  "state": "abc123",
  "country": "abc123",
  "countryCode": "abc123"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

Buyer

Description

The buyer is the person who has been billed for the order

Fields
Field Name Description
fullName - String! Full name ("first_name last_name")
firstName - String! First name
lastName - String! Last name
address - Address! Address
previous - Buyer Previous buyer if it has been updated
Example
{
  "fullName": "abc123",
  "firstName": "abc123",
  "lastName": "xyz789",
  "address": Address,
  "previous": Buyer
}
Types

Claim

Description

Claim

Fields
Field Name Description
id - ID! ID
reason - ClaimReason! Reason
otherReasonLabel - String Other reason label written by the support team when the reason is "OTHER"
messageFromSupport - String Message written by the support team to the seller
reshipActionErrorReasons - [ClaimReshipActionErrorReason!]! Reship action error reasons if the action is not available
actionFromSeller - ClaimSellerAction Action chose by the seller when it has accepted the claim
items - [Item!]! Items
proofUrls - [String!]! Proof URLs
isAccepted - Boolean! Is accepted ?
acceptedMessage - String Message written by the seller when it accept the claim
isDeclined - Boolean! Is declined ?
declinedMessage - String Message written by the seller when it decline the claim
createdAt - DateTime! Date of the creation
updatedAt - DateTime! Latest update date
isOpenedByBot - Boolean! Was created by automatic flow ?
Example
{
  "id": 4,
  "reason": "NOT_DELIVERED_AND_RETURNED_TO_SENDER",
  "otherReasonLabel": "abc123",
  "messageFromSupport": "abc123",
  "reshipActionErrorReasons": ["ORDER_ALREADY_RESHIPPED"],
  "actionFromSeller": "DIRECTLY_HANDLED_WITH_THE_CUSTOMER",
  "items": [Item],
  "proofUrls": ["abc123"],
  "isAccepted": true,
  "acceptedMessage": "abc123",
  "isDeclined": true,
  "declinedMessage": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "isOpenedByBot": false
}
Types

ClaimReason

Description

Claim Reason

Values
Enum Value Description

NOT_DELIVERED_AND_RETURNED_TO_SENDER

 The customer has not received the parcel and has been returned to the sender

NOT_DELIVERED_AND_TRACKING_BLOCKED

 The customer has not received the parcel and the tracking is blocked

NOT_DELIVERED_AND_TRACKING_DELIVERED

 The customer has not received the parcel and the tracking is delivered

DELIVERED_BUT_DAMAGED

 The customer has received the parcel but is damaged

DELIVERED_BUT_INCOMPLETE

 The customer has received the parcel but is incomplete

DELIVERED_BUT_WRONG

 The customer has received the parcel but is wrong (wrong or missing items)

DIGITAL_COUPON_CODE_NOT_WORKING

 The customer has received a digital coupon code but is not working

OTHER

 Other
Example
"NOT_DELIVERED_AND_RETURNED_TO_SENDER"
Types

ClaimReshipActionErrorReason

Description

Claim reship action error reason

Values
Enum Value Description

ORDER_ALREADY_RESHIPPED

 The order has already been reshipped

ORDER_CANCELLED

 The order is cancelled

NO_ITEMS

 There is no items to reship

SOME_ITEMS_CANCELLED

 Some of the items to reship are cancelled

SOME_ITEMS_DIGITAL

 Some of the items to reship are digital
Example
"ORDER_ALREADY_RESHIPPED"
Types

ClaimSellerAction

Description

Claim seller action (action chose by the seller when it has accepted the claim)

Values
Enum Value Description

DIRECTLY_HANDLED_WITH_THE_CUSTOMER

 The seller has directy handled the claim with the customer

ITEMS_DIGITAL_COUPON_CODES_RESENT

 The seller decided to resend a new digital coupon code for the items

ITEMS_REFUNDED

 The seller decided to refund the items

ITEMS_RESHIPPED

 The seller decided to reship the items
Example
"DIRECTLY_HANDLED_WITH_THE_CUSTOMER"
Types

CurrencyISO

Description

Currency ISO code

Values
Enum Value Description

eur

 Euro

usd

 US Dollar
Example
"eur"
Types

Date

Example
"2007-12-03"
Types

DateTime

Example
"2007-12-03T10:15:30Z"
Types

DeliveryDateRange

Description

Represents a range of date and time when the parcel is expected to arrive at the customer's location

Fields
Field Name Description
start - Date! The earliest delivery date and time when the parcel is expected to arrive at the customer's location
end - Date! The latest delivery date and time when the parcel is expected to arrive at the customer's location
createdAt - DateTime! The creation date
Example
{
  "start": "2007-12-03",
  "end": "2007-12-03",
  "createdAt": "2007-12-03T10:15:30Z"
}
Types

FloatPercentage

Example
FloatPercentage
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

Item

Description

Item

Fields
Field Name Description
id - ID! ID
productId - String! Product ID
productVariantId - String Product variant ID
name - String! Name
imageUrl - String! Image URL
size - String Size
sku - String SKU
gtin - String GTIN
priceBoughtByChoose - Price! Price bought by Choose
priceSold - Price! Price sold by Choose to the customer (in cents)
digitalCouponCode - String Digital coupon code
newDigitalCouponCode - String New digital coupon code
isDigital - Boolean! Is digital ?
isOffered - Boolean! Is offered ?
isCancellable - Boolean! Is cancellable ?
isCancelled - Boolean! Is cancelled ?
isReshipped - Boolean! Is reshipped ?
isReturnable - Boolean! Is returnable ?
isReturnGenerated - Boolean! A return has been generated for this item ?
isReturnValidated - Boolean! A return has been validated for this item ?
returnReasonCode - ItemReturnReasonCode Return reason code
refundSummary - OrderLineRefundSummary! Refund summary
Example
{
  "id": "4",
  "productId": "abc123",
  "productVariantId": "abc123",
  "name": "abc123",
  "imageUrl": "abc123",
  "size": "abc123",
  "sku": "xyz789",
  "gtin": "abc123",
  "priceBoughtByChoose": Price,
  "priceSold": Price,
  "digitalCouponCode": "xyz789",
  "newDigitalCouponCode": "xyz789",
  "isDigital": true,
  "isOffered": true,
  "isCancellable": false,
  "isCancelled": true,
  "isReshipped": false,
  "isReturnable": true,
  "isReturnGenerated": true,
  "isReturnValidated": false,
  "returnReasonCode": "BETTER_PRICE",
  "refundSummary": OrderLineRefundSummary
}
Types

ItemReturnReasonCode

Description

Item return reason code

Values
Enum Value Description

BETTER_PRICE

 Better price

DAMAGED_PRODUCT

 Damaged product

DAMAGED_SHIPPING

 Damaged shipping

DELAY

 Delay

DESCRIPTION

 Description

OTHER

 Other

PICTURE

 Picture

QUALITY

 Quality

SIZE

 Size

WRONG_ARTICLE

 Wrong article
Example
"BETTER_PRICE"
Types

NonEmptyString

Example
"string"
Types

OperationType

Description

Operation type

Values
Enum Value Description

DROP_SHIPPING

 The seller sell its products and ship on its own

FIRM_PURCHASE

 Choose has ordered the products before the operation and ship on its own

POST_OPERATION_PURCHASE

 Choose order the products sold after the operation and ship it on its own

RESELLER

 The reseller sell products from another seller => Not used anymore
Example
"DROP_SHIPPING"
Types

Order

Description

Order

Fields
Field Name Description
id - ID! ID
billingId - ID! Billing ID
customerId - ID! Customer ID
sellerId - ID! Seller ID
saleId - ID! Sale ID
initialOrderId - ID ID of the initial order if this is a reship order
initialOrder - Order Initial order if this is a reship order
reshipOrderId - ID ID of the reship order if this is an initial order reshipped
reshipOrder - Order Reship order if this is an initial order reshipped
buyer - Buyer! The buyer is the person who has been billed for the order
recipient - Recipient! The recipient is the person who will receive the order
shipping - OrderShipping! Shipping infos
isShippingEstimatedTimeExceeded - Boolean! Is shipping estimated time exceeded ?
totalPriceSold - Price! Total price sold (items) by Choose to the customer (in cents)
items - [Item!]! Items ordered by the customer
parcels - [Parcel!]! Parcels
returnParcels - [ReturnParcel!]! Return parcels
returnSlips - [ReturnSlip!]! Return slips
claims - [Claim!]! Claims
linesRefunds - [OrderLineRefund!]! Lines refunds
rating - OrderRating Rating
integration - OrderIntegration! Integration
operationType - OperationType! Operation type
payment - OrderPayment! Payment infos
hasBeenExported - Boolean! Has been exported by the seller ? (using a CSV from the dashboard in order to not process it twice)
hasSellerError - Boolean! Has seller error ?
hasSynchronizationError - Boolean! Has synchronization error ?
isCancelled - Boolean! Is cancelled ?
isFullDigital - Boolean! Does the order include only digital items ?
splitActionErrorReasons - [OrderSplitActionErrorReason!]! Split action error reasons if the action is not available
createdAt - DateTime! Date of the creation
tags - OrderTags! Tags
tagging - OrderTagging! Tagging Use tags instead
Example
{
  "id": "4",
  "billingId": 4,
  "customerId": "4",
  "sellerId": "4",
  "saleId": "4",
  "initialOrderId": 4,
  "initialOrder": Order,
  "reshipOrderId": 4,
  "reshipOrder": Order,
  "buyer": Buyer,
  "recipient": Recipient,
  "shipping": OrderShipping,
  "isShippingEstimatedTimeExceeded": true,
  "totalPriceSold": Price,
  "items": [Item],
  "parcels": [Parcel],
  "returnParcels": [ReturnParcel],
  "returnSlips": [ReturnSlip],
  "claims": [Claim],
  "linesRefunds": [OrderLineRefund],
  "rating": OrderRating,
  "integration": OrderIntegration,
  "operationType": "DROP_SHIPPING",
  "payment": OrderPayment,
  "hasBeenExported": false,
  "hasSellerError": true,
  "hasSynchronizationError": false,
  "isCancelled": true,
  "isFullDigital": false,
  "splitActionErrorReasons": ["ORDER_CANCELLED"],
  "createdAt": "2007-12-03T10:15:30Z",
  "tags": OrderTags,
  "tagging": OrderTagging
}
Types

OrderIntegration

Description

Order integration

Fields
Field Name Description
orderId - ID ID of the order from the integration (Shopify, StockAZ)
errorMessage - String Error message from the integration (Shopify, StockAZ)
shopify - ShopifyOrderIntegration Shopify integration
Example
{
  "orderId": "4",
  "errorMessage": "xyz789",
  "shopify": ShopifyOrderIntegration
}
Types

OrderLineRefund

Description

Order line refund

Fields
Field Name Description
id - ID! Identifier of the refund
planId - ID! Identifier of the plan (refunds made at the same time have the same plan id)
lineId - ID! Identifier of the line (item id for "ITEM" and order id for "SHIPPING" and "LEGACY")
lineType - OrderLineType! Line type ("ITEM" or "SHIPPING")
amountInCents - PositiveInteger! Amount in cents of the refund
createdAt - DateTime! Creation date of the refund
Example
{
  "id": "4",
  "planId": "4",
  "lineId": 4,
  "lineType": "ITEM",
  "amountInCents": PositiveInteger,
  "createdAt": "2007-12-03T10:15:30Z"
}
Types

OrderLineRefundSummary

Description

Order line refund summary

Fields
Field Name Description
isRefundable - Boolean!

Is refundable ?

Is not offered and not removed and has a price greater than 0
isTotallyRefunded - Boolean!

Is totally refunded ?

Has at least one refund and the refunded amount is equal to the price
refundedAmountInCents - PositiveInteger! Refunded amount of the price in cents
refundedAmountInPercentage - FloatPercentage!

Refunded amount of the price in percentage

Is between 0 and 100
remainingToRefundAmountInCents - PositiveInteger! Remaining to refund amount of the price in cents
remainingToRefundAmountInPercentage - FloatPercentage!

Remaining to refund amount of the price in percentage

Is between 0 and 100
Example
{
  "isRefundable": true,
  "isTotallyRefunded": false,
  "refundedAmountInCents": PositiveInteger,
  "refundedAmountInPercentage": FloatPercentage,
  "remainingToRefundAmountInCents": PositiveInteger,
  "remainingToRefundAmountInPercentage": FloatPercentage
}
Types

OrderLineType

Description

Order line type

Values
Enum Value Description

ITEM

 Item

SHIPPING

 Shipping

LEGACY

 Legacy (not associated to an item or a shipping)
Example
"ITEM"
Types

OrderPayment

Description

Order payment

Fields
Field Name Description
transactionCurrency - CurrencyISO! Currency used for the payment transaction
processor - PaymentProcessor! Processor used for the payment
subProcessor - PaymentSubProcessor Sub processor used for the payment
processorDetailed - String! Processor detailed (eg: "stripe (ios Apple Pay)")
processorTransactionId - String! Processor transaction id
processorTransactionUrl - String! Url of the transaction in the processor dashboard
Example
{
  "transactionCurrency": "eur",
  "processor": "Alma",
  "subProcessor": "PayPal",
  "processorDetailed": "xyz789",
  "processorTransactionId": "abc123",
  "processorTransactionUrl": "abc123"
}
Types

OrderRating

Description

Order rating

Fields
Field Name Description
rate - Int! Rate (between 1 and 5)
message - String Message
Example
{"rate": 123, "message": "abc123"}
Types

OrderShipping

Description

Order shipping

Fields
Field Name Description
fees - Int! Fees (in cents)
feesSold - Int! Fees sold by Choose to the customer (in cents)
estimatedTime - Int! Estimated time in days
policyId - ID Policy ID
pickupPoint - PickupPoint Pickup point
deliveryDateRangeHistory - [DeliveryDateRange!]! Delivery date range history (ordered by createdAt desc)
refundSummary - OrderLineRefundSummary! Refund summary
Example
{
  "fees": 987,
  "feesSold": 123,
  "estimatedTime": 987,
  "policyId": 4,
  "pickupPoint": PickupPoint,
  "deliveryDateRangeHistory": [DeliveryDateRange],
  "refundSummary": OrderLineRefundSummary
}
Types

OrderShippingTag

Description

Order shipping tag

Values
Enum Value Description

PENDING_SHIPPING_INFO

 A parcel is pending for the shipping info (tracking number)

WAITING_FOR_SHIPPING

 A parcel has the shipping info and is waiting to be given to the carrier

IN_PROGRESS

 A parcel has been shipped and is in progress

LOST

 A parcel has been lost

DELIVERED

 A parcel has been delivered to the customer
Example
"PENDING_SHIPPING_INFO"
Types

OrderSplitActionErrorReason

Description

Order split action error reason

Values
Enum Value Description

ORDER_CANCELLED

 The order is cancelled

ORDER_RESHIPPED

 The order has been reshipped

ALL_ITEMS_DIGITAL

 The order has all the items digital

SOME_CLAIMS_PENDING

 The order has some claims pending

SOME_REFUNDS

 The order has some refunds

SOME_RETURN_PARCELS

 The order has some return parcels

SOME_RETURN_SLIPS

 The order has some return slips
Example
"ORDER_CANCELLED"
Types

OrderTagBrand

Description

Order tag brand

Values
Enum Value Description

ACTION_REQUIRED_UNFULFILLED

 The order is available for the brand and requires an action because unfulfilled

ACTION_REQUIRED_SHIPMENT_INCIDENT

 The order is available for the brand and requires an action because shipment incident

ACTION_REQUIRED_CLAIM

 The order is available for the brand and requires an action because claim

ACTION_REQUIRED_RETURN

 The order is available for the brand and requires an action because return

ACTION_REQUIRED

 The order is available for the brand and requires an action

AVAILABLE

 The order is available for the brand
Example
"ACTION_REQUIRED_UNFULFILLED"
Types

OrderTagClaim

Description

Order tag claim

Values
Enum Value Description

NONE

 The order has no claim

OPENED

 The order has some opened claims

CLOSED

 The order has some closed claims
Example
"NONE"
Types

OrderTagFulfillment

Description

Order tag fulfillment

Values
Enum Value Description

UNFULFILLED

 The order has none of the items that are eligible to shipment in a shipment

FULFILLED

 The order has all the items that are eligible to shipment in a shipment
Example
"UNFULFILLED"
Types

OrderTagRefund

Description

Order tag refund

Values
Enum Value Description

NONE

 The order has no refund

PARTIALLY_REFUNDED

 The order has some refunds but not totally refunded

TOTALLY_REFUNDED

 The order has some refunds and totally refunded
Example
"NONE"
Types

OrderTagReship

Description

Order tag reship

Values
Enum Value Description

NONE

 The order has no reship

RESHIPPED

 The order has some reships
Example
"NONE"
Types

OrderTagReturn

Description

Order tag return

Values
Enum Value Description

NONE

 The order has no return

CANCELED

 The order has some canceled returns

REQUESTED

 The order has some requested returns

IN_PROGRESS

 The order has some in progress returns

DELIVERED

 The order has some delivered returns

VALIDATED

 The order has some validated returns
Example
"NONE"
Types

OrderTagShipment

Description

Order tag shipment

Values
Enum Value Description

NONE

 The order has no shipment

PENDING

 The order has some pending shipments

INFO_RECEIVED

 The order has some info received shipments

IN_TRANSIT

 The order has some in transit shipments

OUT_FOR_DELIVERY

 The order has some out for delivery shipments

ATTEMPT_FAIL

 The order has some attempt fail shipments

AVAILABLE_FOR_PICKUP

 The order has some available for pickup shipments

DELIVERED

 The order has some delivered shipments

EXCEPTION

 The order has some exception shipments

EXPIRED

 The order has some expired shipments
Example
"NONE"
Types

OrderTagShippingMode

Description

Order tag shipping mode

Values
Enum Value Description

NONE

 The order will not be shipped (digital items)

PICKUP_POINT

 The shipments will be shipped at a pickup point

HOME

 The shipments will be shipped at the recipient's home
Example
"NONE"
Types

OrderTagShopify

Description

Order tag shopify

Values
Enum Value Description

NONE

 The order has no shopify

UNSYNCHRONIZED

 The order has a shopify and is not synchronized

SYNCHRONIZED

 The order has a shopify and is synchronized
Example
"NONE"
Types

OrderTagStatus

Description

Order tag status

Values
Enum Value Description

CANCELED

 The order has been canceled by the customer or by a member of the support team

PENDING_VALIDATION

 The order has been placed less than 15 minutes ago

VALIDATED

 The order has been placed more than 15 minutes ago
Example
"CANCELED"
Types

OrderTagType

Description

Order tag type

Values
Enum Value Description

DIGITAL

 The order has only digital items

PHYSICAL

 The order has only physical items
Example
"DIGITAL"
Types

OrderTagging

Description

Order tagging

Fields
Field Name Description
shippings - [OrderShippingTag!]! Shipping tags
Example
{"shippings": ["PENDING_SHIPPING_INFO"]}
Types

OrderTags

Description

Order tags

Fields
Field Name Description
brand - [OrderTagBrand!]! Brand tags
type - OrderTagType! Type tag
status - OrderTagStatus! Status tag
shopify - OrderTagShopify! Shopify tag
shippingMode - OrderTagShippingMode! Shipping mode tag
fulfillment - OrderTagFulfillment! Fulfillment tag
shipment - [OrderTagShipment!]! Shipment tags
claim - [OrderTagClaim!]! Claim tags
refund - OrderTagRefund! Refund tag
reship - OrderTagReship! Reship tag
return - [OrderTagReturn!]! Return tags
Example
{
  "brand": ["ACTION_REQUIRED_UNFULFILLED"],
  "type": "DIGITAL",
  "status": "CANCELED",
  "shopify": "NONE",
  "shippingMode": "NONE",
  "fulfillment": "UNFULFILLED",
  "shipment": ["NONE"],
  "claim": ["NONE"],
  "refund": "NONE",
  "reship": "NONE",
  "return": ["NONE"]
}
Types

Orders

Description

Orders

Fields
Field Name Description
nodes - [Order!]! Nodes
paging - Paging! Paging
totalCount - PositiveInteger! Total count
Example
{
  "nodes": [Order],
  "paging": Paging,
  "totalCount": PositiveInteger
}
Types

OrdersConnection

Description

Orders connection

Fields
Field Name Description
nodes - [Order!]! Nodes (orders)
pageInfo - PageInfoConnection! Page info
Example
{
  "nodes": [Order],
  "pageInfo": PageInfoConnection
}
Types

OrdersFilter

Description

Filter on orders

Fields
Input Field Description
tagging - OrdersTaggingFilter Filter on tagging
Example
{"tagging": OrdersTaggingFilter}
Types

OrdersFilterCreationDateInput

Description

Orders filter creation date input

Fields
Input Field Description
from - DateTime Filter from this creation date
to - DateTime Filter to this creation date
Example
{
  "from": "2007-12-03T10:15:30Z",
  "to": "2007-12-03T10:15:30Z"
}
Types

OrdersFilterInput

Description

Orders filter input

Fields
Input Field Description
creationDate - OrdersFilterCreationDateInput Filter with creation date
itemSku - String Filter with item SKU
tagging - OrdersFilterTaggingInput Filter with tagging
Example
{
  "creationDate": OrdersFilterCreationDateInput,
  "itemSku": "xyz789",
  "tagging": OrdersFilterTaggingInput
}
Types

OrdersFilterTaggingInput

Description

Orders filter tagging input

Fields
Input Field Description
brand - [OrderTagBrand!] Filter on brand tags
type - [OrderTagType!] Filter on type tags
status - [OrderTagStatus!] Filter on status tags
shopify - [OrderTagShopify!] Filter on shopify tags
shippingMode - [OrderTagShippingMode!] Filter on shipping mode tags
fulfillment - [OrderTagFulfillment!] Filter on fulfillment tags
shipment - [OrderTagShipment!] Filter on shipment tags
claim - [OrderTagClaim!] Filter on claim tags
refund - [OrderTagRefund!] Filter on refund tags
reship - [OrderTagReship!] Filter on reship tags
return - [OrderTagReturn!] Filter on return tags
Example
{
  "brand": ["ACTION_REQUIRED_UNFULFILLED"],
  "type": ["DIGITAL"],
  "status": ["CANCELED"],
  "shopify": ["NONE"],
  "shippingMode": ["NONE"],
  "fulfillment": ["UNFULFILLED"],
  "shipment": ["NONE"],
  "claim": ["NONE"],
  "refund": ["NONE"],
  "reship": ["NONE"],
  "return": ["NONE"]
}
Types

OrdersInput

Description

Orders input

Fields
Input Field Description
filter - OrdersFilterInput Filter
search - OrdersSearchInput Search
sort - OrdersSortInput! Sort
paging - PagingInput! Paging
Example
{
  "filter": OrdersFilterInput,
  "search": OrdersSearchInput,
  "sort": OrdersSortInput,
  "paging": PagingInput
}
Types

OrdersPaginatedInput

Description

Orders paginated input

Fields
Input Field Description
limit - Int Number of orders per page to retrieve
page - Int Page to retrieve
filter - OrdersFilter Filter on orders to apply
search - String Search on orders to apply
orderBy - OrdersSort Sort on orders to apply
Example
{
  "limit": 987,
  "page": 123,
  "filter": OrdersFilter,
  "search": "abc123",
  "orderBy": OrdersSort
}
Types

OrdersSearchFieldInput

Description

Orders filter search field input

Values
Enum Value Description

ALL

 Search in all available fields (order identifier, recipient full name and item SKU)
Example
"ALL"
Types

OrdersSearchInput

Description

Orders search input

Fields
Input Field Description
field - OrdersSearchFieldInput! Field to search into
term - NonEmptyString! Term to search
Example
{"field": "ALL", "term": "string"}
Types

OrdersSort

Description

Orders sort

Fields
Input Field Description
creationDate - Sort Sort by creation date
Example
{"creationDate": "ASCENDING"}
Types

OrdersSortFieldInput

Description

Orders sort field input

Values
Enum Value Description

CREATION_DATE

 Sort on creation date

RECIPIENT_FULL_NAME

 Sort on recipient full name

TOTAL_PRICE_SOLD

 Sort on total price sold

TAG_BRAND

 Sort on brand tag

TAG_TYPE

 Sort on type tag

TAG_STATUS

 Sort on status tag

TAG_SHOPIFY

 Sort on shopify tag

TAG_SHIPPING_MODE

 Sort on shipping mode tag

TAG_FULFILLMENT

 Sort on fulfillment tag

TAG_SHIPMENT

 Sort on shipment tag

TAG_CLAIM

 Sort on claim tag

TAG_REFUND

 Sort on refund tag

TAG_RESHIP

 Sort on reship tag

TAG_RETURN

 Sort on return tag
Example
"CREATION_DATE"
Types

OrdersSortInput

Description

Orders sort input

Fields
Input Field Description
field - OrdersSortFieldInput! Field to sort
order - OrdersSortOrderInput! Order to sort
Example
{"field": "CREATION_DATE", "order": "ASCENDING"}
Types

OrdersSortOrderInput

Description

Orders sort order input

Values
Enum Value Description

ASCENDING

 Sort in ascending order

DESCENDING

 Sort in descending order
Example
"ASCENDING"
Types

OrdersTaggingFilter

Description

Filter on orders tagging

Fields
Input Field Description
shippings - [OrderShippingTag!] Filter on shipping related tags
Example
{"shippings": ["PENDING_SHIPPING_INFO"]}
Types

PageInfoConnection

Description

Page info connection

Fields
Field Name Description
hasNextPage - Boolean! Has next page ?
totalCount - Int Total count
totalPages - Int Total pages
currentPage - Int *Current page
currentLimit - Int Current limit
Example
{
  "hasNextPage": true,
  "totalCount": 123,
  "totalPages": 123,
  "currentPage": 123,
  "currentLimit": 123
}
Types

Paging

Description

Paging

Fields
Field Name Description
hasPreviousPage - Boolean! Has previous page ?
hasNextPage - Boolean! Has next page ?
startCursor - ID Start cursor
endCursor - ID End cursor
pageSize - PositiveInteger! Page size
Example
{
  "hasPreviousPage": true,
  "hasNextPage": false,
  "startCursor": 4,
  "endCursor": "4",
  "pageSize": PositiveInteger
}
Types

PagingInput

Description

Paging input

Fields
Input Field Description
beforeCursor - ID Before cursor
afterCursor - ID After cursor
pageSize - PositiveInteger! Page size
Example
{
  "beforeCursor": "4",
  "afterCursor": "4",
  "pageSize": PositiveInteger
}
Types

Parcel

Description

Parcel

Fields
Field Name Description
id - ID! ID
items - [Item!]! Items
recipient - Recipient! Recipient
trackingCarrierSlug - String! Tracking carrier slug
trackingNumber - String! Tracking number
trackingStatus - TrackingStatus! Tracking status
trackingSubStatus - TrackingSubStatus Tracking sub status
trackingUrl - String! Tracking URL
trackingUpdatedAt - DateTime Date of the last tracking update
trackingDeliveredAt - DateTime Date when the parcel was delivered
hasTrackingStucked - Boolean!

Does the parcel has its tracking stucked or not ?

  • only if more than 3 days in 'pending' for now
Example
{
  "id": "4",
  "items": [Item],
  "recipient": Recipient,
  "trackingCarrierSlug": "abc123",
  "trackingNumber": "abc123",
  "trackingStatus": "PENDING",
  "trackingSubStatus": "PENDING_NO_INFORMATION_AVAILABLE",
  "trackingUrl": "xyz789",
  "trackingUpdatedAt": "2007-12-03T10:15:30Z",
  "trackingDeliveredAt": "2007-12-03T10:15:30Z",
  "hasTrackingStucked": true
}
Types

ParcelTrackingInfo

Description

Parcel tracking info input

Fields
Input Field Description
slug - String Tracking carrier slug
trackingNumber - String! Tracking number
Example
{
  "slug": "abc123",
  "trackingNumber": "xyz789"
}
Types

PaymentProcessor

Description

Payment processor

Values
Enum Value Description

Alma

 Alma

Braintree

 Braintree

Stripe

 Stripe

Choose

 Choose
Example
"Alma"
Types

PaymentSubProcessor

Description

**Payment Sub-processor - Stripe Specific **

Values
Enum Value Description

PayPal

 PayPal

Bancontact

 Bancontact

Klarna

 Klarna
Example
"PayPal"
Types

PickupAddress

Description

Pickup point address

Fields
Field Name Description
name - String! name
street - String! street
streetAdditional - String streetAdditional
zipCode - String! zipCode
city - String! city
countryCode - String! Country code
Example
{
  "name": "abc123",
  "street": "xyz789",
  "streetAdditional": "abc123",
  "zipCode": "xyz789",
  "city": "abc123",
  "countryCode": "xyz789"
}
Types

PickupPoint

Description

Pickup point

Fields
Field Name Description
id - ID! Id
countryCode - String! Country code
address - PickupAddress Address
network - PickupPointNetwork! Network
Example
{
  "id": 4,
  "countryCode": "abc123",
  "address": PickupAddress,
  "network": "COLISSIMO"
}
Types

PickupPointNetwork

Description

Pickup point network

Values
Enum Value Description

COLISSIMO

 Colissimo

MONDIAL_RELAY

 Mondial relay
Example
"COLISSIMO"
Types

PositiveInteger

Example
PositiveInteger
Types

Price

Description

Price

Fields
Field Name Description
valueWithVat - Int! Value with VAT (in cents)
valueWithoutVat - Int! Value without VAT (in cents)
currency - CurrencyISO! Currency ISO code
Example
{"valueWithVat": 123, "valueWithoutVat": 987, "currency": "eur"}
Types

Recipient

Description

The recipient is the person who will receive the order

Fields
Field Name Description
id - ID! Identifier
fullName - String! Full name ("first_name last_name")
firstName - String! First name
lastName - String! Last name
email - String! Email
phoneNumber - String! Phone number
address - Address! Address
previous - Recipient Previous recipient if it has been updated
Example
{
  "id": 4,
  "fullName": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "xyz789",
  "phoneNumber": "xyz789",
  "address": Address,
  "previous": Recipient
}
Types

ReturnParcel

Description

ReturnParcel

Fields
Field Name Description
id - ID! ID
returnSlipId - ID! Return slip id
items - [Item!]! Items
trackingCarrierSlug - String! Tracking carrier slug
trackingNumber - String! Tracking number
trackingStatus - TrackingStatus! Tracking status
trackingUrl - String! Tracking URL
trackingUpdatedAt - DateTime! Date of the last tracking update
trackingDeliveredAt - DateTime Date when the parcel was delivered
Example
{
  "id": 4,
  "returnSlipId": "4",
  "items": [Item],
  "trackingCarrierSlug": "abc123",
  "trackingNumber": "abc123",
  "trackingStatus": "PENDING",
  "trackingUrl": "abc123",
  "trackingUpdatedAt": "2007-12-03T10:15:30Z",
  "trackingDeliveredAt": "2007-12-03T10:15:30Z"
}
Types

ReturnSlip

Description

Return slip

Fields
Field Name Description
id - ID! ID
trackingCarrierSlug - String! Tracking carrier slug
trackingNumber - String! Tracking number
trackingUrl - String! Tracking URL
items - [Item!]! Items
createdAt - DateTime! Created at
Example
{
  "id": "4",
  "trackingCarrierSlug": "xyz789",
  "trackingNumber": "xyz789",
  "trackingUrl": "abc123",
  "items": [Item],
  "createdAt": "2007-12-03T10:15:30Z"
}
Types

ShopifyOrderIntegration

Description

Shopify order integration

Fields
Field Name Description
orderId - ID! ID of the order from Shopify
orderUrl - String! URL of the order from Shopify
Example
{
  "orderId": "4",
  "orderUrl": "xyz789"
}
Types

Sort

Description

Sort

Values
Enum Value Description

ASCENDING

 Sort ascending

DESCENDING

 Sort descending
Example
"ASCENDING"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

SystemInfo

Description

System information

Fields
Field Name Description
buildVersion - String! Build version
version - String! Code version
environment - String! Code environment
Example
{
  "buildVersion": "abc123",
  "version": "xyz789",
  "environment": "abc123"
}
Types

TrackingStatus

Description

Tracking status

Values
Enum Value Description

PENDING

 Pending

INFO_RECEIVED

 Info received

IN_TRANSIT

 In transit

OUT_FOR_DELIVERY

 Out for delivery

ATTEMPT_FAIL

 Attempt fail

AVAILABLE_FOR_PICKUP

 Available for pickup

DELIVERED

 Delivered

EXCEPTION

 Exception

EXPIRED

 Expired
Example
"PENDING"
Types

TrackingSubStatus

Description

Tracking sub status

Values
Enum Value Description

PENDING_NO_INFORMATION_AVAILABLE

 No information available on the carrier website or the tracking number is yet to be tracked (Pending_001)

PENDING_NO_CONNECTION_WITH_CARRIER

 It represents the shipments are pending due to no connection with carrier accounts (Pending_002)

PENDING_NOT_SCANNED

 The order has been processed / packaged, but not scanned at a shipping location yet (Pending_003)

PENDING_WRONG_CARRIER

 There is no tracking info available because the carrier is wrong (Pending_004)

PENDING_NO_UPDATE

 There have been no new tracking updates in the last 120 days (Pending_005)

PENDING_CARRIER_UNRECOGNIZED

 Can’t track this type of shipment as the carrier is unrecognized (Pending_006)

INFO_RECEIVED_ABOUT_TO_PICKUP

 The carrier received a request from the shipper and is about to pick up the shipment (InfoReceived_001)

IN_TRANSIT_ON_THE_WAY

 Shipment on the way (InTransit_001)

IN_TRANSIT_ACCEPTED_BY_CARRIER

 Shipment accepted by the carrier (InTransit_002)

IN_TRANSIT_ARRIVED_AT_A_HUB_OR_SORTING_CENTER

 Shipment arrived at a hub or sorting center (InTransit_003)

IN_TRANSIT_ARRIVED_AT_DESTINATION_COUNTRY_OR_REGION

 International shipment arrived at the destination country / region (InTransit_004)

IN_TRANSIT_CUSTOMS_CLEARANCE_COMPLETED

 Customs clearance completed (InTransit_005)

IN_TRANSIT_HANDED_OVER_TO_CUSTOMS_FOR_CLEARANCE

 Package handed over to customs for clearance (InTransit_006)

IN_TRANSIT_DEPARTED_FROM_FACILITY

 Package departed from the facility (InTransit_007)

IN_TRANSIT_PROBLEM_RESOLVED

 Problem resolved and shipment in transit (InTransit_008)

IN_TRANSIT_FORWARDED_TO_A_DIFFERENT_DELIVERY_ADDRESS

 Shipment forwarded to a different delivery address (InTransit_009)

OUT_FOR_DELIVERY

 The package is out for delivery (OutForDelivery_001)

OUT_FOR_DELIVERY_RECIPIENT_CONTACTED

 The recipient is contacted before the final delivery (OutForDelivery_003)

OUT_FOR_DELIVERY_APPOINTMENT_SCHEDULED

 A delivery appointment is scheduled (OutForDelivery_004)

ATTEMPT_FAIL_DUE_TO_SOME_REASON

 The delivery of the package failed due to some reason. Courier usually leaves a notice and will try to deliver again (AttemptFail_001)

ATTEMPT_FAIL_RECIPIENT_NOT_AVAILABLE

 Recipient not available at the given address (AttemptFail_002)

ATTEMPT_FAIL_BUSINESS_CLOSED

 Business is closed at the time of delivery (AttemptFail_003)

AVAILABLE_FOR_PICKUP

 The package arrived at a pickup point near you and is available for pickup (AvailableForPickup_001)

DELIVERED_SUCCESSFULLY

 Shipment delivered successfully (Delivered_001)

DELIVERED_PICKED_UP_BY_RECIPIENT

 Package picked up by the recipient (Delivered_002)

DELIVERED_AND_SIGNED_BY_RECIPIENT

 Package delivered to and signed by the recipient (Delivered_003)

DELIVERED_AND_CASH_COLLECTED

 Package delivered to the recipient and cash collected on delivery (Delivered_004)

DELIVERED_MARKED_BY_CUSTOMER

 CUSTOM: Marked delivered by the customer (Delivered_Mark_By_Customer)

DELIVERED_MARKED_BY_SUPPORT_TEAM

 CUSTOM: Marked delivered by a member of the support team (Delivered_Mark_By_Support)

EXCEPTION_SHIPPING_EXCEPTION

 Delivery of the package failed due to some shipping exception (Exception_001)

EXCEPTION_RECIPIENT_RELOCATED

 Delivery of the package failed as the recipient relocated (Exception_002)

EXCEPTION_RECIPIENT_REFUSED

 Delivery of the package failed as the recipient refused to take the package due to some reason (Exception_003)

EXCEPTION_DELAYED_CUSTOMS_CLEARANCE

 Package delayed due to some issues during the customs clearance (Exception_004)

EXCEPTION_UNFORSEEN_REASON

 Package delayed due to some unforeseen reasons (Exception_005)

EXCEPTION_PENDING_PAYMENT

 The package being held due to pending payment from the recipient's end (Exception_006)

EXCEPTION_INCORRECT_RECIPIENT_ADDRESS

 Package not delivered due to incorrect recipient address (Exception_007)

EXCEPTION_PICKUP_NOT_COLLECTED_BY_RECIPIENT

 Package available for the pickup but not collected by the recipient (Exception_008)

EXCEPTION_REJECTED_BY_CARRIER

 Package rejected by the carrier due to noncompliance with its guidelines (Exception_009)

EXCEPTION_BACK_TO_SENDER

 The package is on its way back to the sender (Exception_010)

EXCEPTION_BACK_TO_SENDER_RECEIVED

 The return package has been successfully received by the sender (Exception_011)

EXCEPTION_DAMAGED

 Shipment damaged (Exception_012)

EXCEPTION_LOST

 Delivery of the package failed as it got lost (Exception_013)

EXPIRED_NO_TRACKING_INFORMATION

 No tracking information of the shipment, from the last 30 days (Expired_001)
Example
"PENDING_NO_INFORMATION_AVAILABLE"
Types

Void

Documentation by Anvil SpectaQL