Order resource

Methods

  • get - Get an order by ID

Resource

{
    "allowPaymentMethodRegistration": "boolean",
    "cancelPeriod": "int32",
    "cardType": "string",
    "cartId": "string",
    "catalogId": "string",
    "consentFlags": {
        "newsletterOptin": "boolean"
    },
    "createDate": "date-time",
    "creditNotes": [
        {
            "cancellationReason": "string",
            "date": "date-time",
            "id": "string",
            "type": "string"
        }
    ],
    "currency": "string",
    "customer": {
        "id": "string",
        "status": "string"
    },
    "dbVersion": "int64",
    "emailCancellationStatus": "string",
    "emailConfirmationStatus": "string",
    "emails": [
        {
            "emailId": "string",
            "id": "string",
            "type": "string"
        }
    ],
    "endUser": {
        "city": "string",
        "company": {
            "cnpj": "string",
            "companyName": "string",
            "vatNumber": "string"
        },
        "country": "string",
        "cpf": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "locale": "string",
        "storeId": "string",
        "streetAddress": "string",
        "zipCode": "string"
    },
    "endUserCreationStatus": "string",
    "endUserIp": "string",
    "externalContext": "string",
    "fulfillmentStatus": "string",
    "fullCreditNoteStatus": "string",
    "fullRefundStatus": "string",
    "fullTotalAmount": {
        "currency": "string",
        "discountedPrice": {
            "discountCode": "string",
            "discountId": "string",
            "discountLabel": "string",
            "discountRate": "double",
            "discountedGrossPrice": "double",
            "discountedNetPrice": "double",
            "grossPriceDiscountAmount": "double",
            "netPriceDiscountAmount": "double",
            "signedDiscount": "string",
            "vatDiscountAmount": "double"
        },
        "grossPrice": "double",
        "netPrice": "double",
        "vatAmount": "double",
        "vatRate": "double"
    },
    "id": "string",
    "informativeDPStatus": "string",
    "informativeSubscriptionStatus": "string",
    "invoice": {
        "date": "date-time",
        "id": "string",
        "type": "string"
    },
    "invoiceStatus": "string",
    "lifeCycleStatus": "string",
    "lineItems": [
        {
            "activationCode": "string",
            "amount": "double",
            "creditNoteProcessingStatus": "string",
            "currency": "string",
            "discountAmount": "double",
            "discountRate": "double",
            "externalContext": "string",
            "fraudPoints": "int32",
            "fulfillmentProcessingStatus": "string",
            "fulfillmentTemplate": "string",
            "id": "string",
            "lifeTime": "string",
            "name": "string",
            "netAmount": "double",
            "nexwayFulfillmentId": "string",
            "price": {
                "currency": "string",
                "discountedPrice": {
                    "discountCode": "string",
                    "discountId": "string",
                    "discountLabel": "string",
                    "discountRate": "double",
                    "discountedGrossPrice": "double",
                    "discountedNetPrice": "double",
                    "grossPriceDiscountAmount": "double",
                    "netPriceDiscountAmount": "double",
                    "signedDiscount": "string",
                    "vatDiscountAmount": "double"
                },
                "grossPrice": "double",
                "netPrice": "double",
                "vatAmount": "double",
                "vatRate": "double"
            },
            "priceFunctionParameters": {
                "<key>": "string"
            },
            "processingEvent": [
                {
                    "createDate": "int64",
                    "error": "string",
                    "message": "string",
                    "metadata": {},
                    "name": "string",
                    "source": "string",
                    "status": "string"
                }
            ],
            "processingStatus": "string",
            "productFamily": "string",
            "productId": "string",
            "publisherFulfillmentId": "string",
            "publisherRefId": "string",
            "relatedContents": [
                {
                    "file": "string",
                    "label": "string"
                }
            ],
            "signedProduct": "string",
            "subscriptionId": "string",
            "subscriptionProcessingStatus": "string",
            "subscriptionTemplate": "string",
            "variables": {},
            "vatAmount": "double",
            "vatRate": "double"
        }
    ],
    "parentOrderId": "string",
    "payment": {
        "methodId": "string",
        "methodType": "string",
        "transactionId": "string",
        "vendor": "string"
    },
    "paymentMethodId": "string",
    "paymentStatus": "string",
    "processingEvent": [
        {
            "createDate": "int64",
            "error": "string",
            "message": "string",
            "metadata": {},
            "name": "string",
            "source": "string",
            "status": "string"
        }
    ],
    "registerPaymentMethodStatus": "string",
    "retailers": [
        {
            "id": "string",
            "marketPay": {
                "accountCode": "string"
            },
            "remittance": {
                "rate": "double"
            },
            "remittanceAmount": "double",
            "storeId": "string"
        }
    ],
    "salesFlag": [
        "string"
    ],
    "salesFlags": [
        "string"
    ],
    "source": "string",
    "status": "string",
    "store": {
        "allowOrderDetailsOnCheckoutConfirmation": "boolean",
        "bannerInvoice": "string",
        "bannerOrderConfEmail": "string",
        "hostnames": [
            "string"
        ],
        "id": "string",
        "name": "string"
    },
    "storeHostname": "string",
    "subscriptionStatus": "string",
    "subsidiaryId": "string",
    "totalAmount": "double",
    "transactionId": "string",
    "updateDate": "date-time",
    "vatRate": "double"
}

Properties

Name Type Description Additional
allowPaymentMethodRegistration boolean

Payment method registration authorized

Optional
cancelPeriod int32

Cancel period in days

Optional
cardType string

Payment type used (Visa, PayPal, etc.)

Optional
cartId string

Reference ID of cart service

Optional, read only.
catalogId string

Catalog ID

Optional
consentFlags object ConsentFlags Optional
consentFlags.newsletterOptin boolean

Newsletter opt-in consent

Optional
createDate date-time Optional
creditNotes[] array

List of credit notes

Optional
creditNotes[].cancellationReason string

Cancelation reason reference ID

creditNotes[].date date-time

Invoice creation date

creditNotes[].id string

Internal reference ID

creditNotes[].type string

Indicates if full or partial cancellation

Possible values are:

  • PARTIAL
  • TOTAL
currency string

Currency

customer object Customer Optional
customer.id string

Customer service reference ID

Read only.
customer.status string

Status

Possible values are:

  • TRIAL
  • RUNNING
  • SUSPENDED
Read only.
dbVersion int64 Optional
emailCancellationStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • FRAUD_PENDING
  • PENDING
  • FAILED
  • COMPLETED
  • CANCELED
Optional
emailConfirmationStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • FRAUD_PENDING
  • PENDING
  • FAILED
  • COMPLETED
  • CANCELED
Optional
emails[] array

List of emails sent

Optional
emails[].emailId string

Email reference in email storage service

emails[].id string

Internal reference ID

emails[].type string

Type of email

Optional
endUser object EndUser Optional
endUser.city string

City

Optional
endUser.company object Company Optional
endUser.company.cnpj string

CNPJ

Optional
endUser.company.companyName string

End-user company name

endUser.company.vatNumber string

Company VAT number

Optional
endUser.country string

Country

endUser.cpf string

CPF value

Optional
endUser.email string

Email

endUser.firstName string

First name

endUser.id string

End-user service reference ID

Optional
endUser.lastName string

Last name

endUser.locale string

End-user locale

endUser.storeId string

Store ID used for end-user account creation

Optional
endUser.streetAddress string

Street address

endUser.zipCode string

Zip/postal code

Optional
endUserCreationStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • FRAUD_PENDING
  • PENDING
  • FAILED
  • COMPLETED
  • CANCELED
Optional
endUserIp string

End-user IP used for purchase

Optional
externalContext string

External context

Optional
fulfillmentStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • CREATION_PENDING
  • CREATION_FAILURE
  • CREATION_ACCEPTED
  • CANCEL_PENDING
  • CANCEL_FAILURE
  • CANCEL_ACCEPTED
Optional
fullCreditNoteStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • FRAUD_PENDING
  • PENDING
  • FAILED
  • COMPLETED
  • CANCELED
Optional
fullRefundStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • FRAUD_PENDING
  • PENDING
  • FAILED
  • COMPLETED
  • CANCELED
Optional
fullTotalAmount object FullPrice
fullTotalAmount.currency string

Purchase currency (ISO-4217 format)

fullTotalAmount.discountedPrice object DiscountedPrice Optional
fullTotalAmount.discountedPrice.discountCode string

Discount promo code

Optional, read only.
fullTotalAmount.discountedPrice.discountId string

Discount ID

Optional, read only.
fullTotalAmount.discountedPrice.discountLabel string

Discount label

Optional, read only.
fullTotalAmount.discountedPrice.discountRate double

Discount rate

Optional, read only.
fullTotalAmount.discountedPrice.discountedGrossPrice double

Discounted cost of product with taxes included

Optional, read only.
fullTotalAmount.discountedPrice.discountedNetPrice double

Discounted cost of product without taxes included

Optional, read only.
fullTotalAmount.discountedPrice.grossPriceDiscountAmount double

Gross price discount amount

Optional, read only.
fullTotalAmount.discountedPrice.netPriceDiscountAmount double

Net price discount amount

Optional, read only.
fullTotalAmount.discountedPrice.signedDiscount string

Signed discount

Optional, read only.
fullTotalAmount.discountedPrice.vatDiscountAmount double

VAT discount amount

Optional, read only.
fullTotalAmount.grossPrice double

Cost of product with taxes included

fullTotalAmount.netPrice double

Net price

fullTotalAmount.vatAmount double

VAT amount (grossPrice - netPrice)

fullTotalAmount.vatRate double

Sales tax rate

id string Optional
informativeDPStatus string Optional
informativeSubscriptionStatus string Optional
invoice object Invoice Optional
invoice.date date-time

Creation date

Optional
invoice.id string

Internal reference ID

invoice.type string

Type

Optional
invoiceStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • FRAUD_PENDING
  • PENDING
  • FAILED
  • COMPLETED
  • CANCELED
Optional
lifeCycleStatus string

Possible values are:

  • CREATED
  • PAYMENT_PENDING
  • FRAUD_PENDING
  • INVOICE_PENDING
  • INVOICE_FAILED
  • SUBSCRIPTION_PENDING
  • FULFILLMENT_PENDING
  • EMAILCONFIRMATION_PENDING
  • FAILED
  • COMPLETED_WITH_ERROR
  • COMPLETED
  • CANCEL_PENDING
  • PARTIALLY_CANCELED
  • PARTIALLY_CANCELED_WITH_ERROR
  • CANCELED_WITH_ERROR
  • CANCELED
Optional
lineItems[] array

List of products

Optional
lineItems[].activationCode string Optional
lineItems[].amount double

Cost of product

Optional
lineItems[].creditNoteProcessingStatus string

Credit note processing status for this line item

Possible values are:

  • NONE
  • INITIALIZED
  • CREATION_PENDING
  • CREATION_FAILURE
  • CREATION_ACCEPTED
  • CANCEL_PENDING
  • CANCEL_FAILURE
  • CANCEL_ACCEPTED
Optional, read only.
lineItems[].currency string

Product currency

Optional
lineItems[].discountAmount double

Discount amount

Optional
lineItems[].discountRate double

Discount rate

Optional
lineItems[].externalContext string

External context

Optional
lineItems[].fraudPoints int32 Optional
lineItems[].fulfillmentProcessingStatus string

Fulfillment processing status for this line item

Possible values are:

  • NONE
  • INITIALIZED
  • CREATION_PENDING
  • CREATION_FAILURE
  • CREATION_ACCEPTED
  • CANCEL_PENDING
  • CANCEL_FAILURE
  • CANCEL_ACCEPTED
Optional, read only.
lineItems[].fulfillmentTemplate string

Fulfillment template name

lineItems[].id string

Internal reference ID

lineItems[].lifeTime string

Lifetime

lineItems[].name string

Product name

Optional
lineItems[].netAmount double

Cost of product with no taxes included

lineItems[].nexwayFulfillmentId string

Nexway fulfillment ID

Optional
lineItems[].price object FullPrice Optional
lineItems[].price.currency string

Purchase currency (ISO-4217 format)

lineItems[].price.discountedPrice object DiscountedPrice Optional
lineItems[].price.discountedPrice.discountCode string

Discount promo code

Optional, read only.
lineItems[].price.discountedPrice.discountId string

Discount ID

Optional, read only.
lineItems[].price.discountedPrice.discountLabel string

Discount label

Optional, read only.
lineItems[].price.discountedPrice.discountRate double

Discount rate

Optional, read only.
lineItems[].price.discountedPrice.discountedGrossPrice double

Discounted cost of product with taxes included

Optional, read only.
lineItems[].price.discountedPrice.discountedNetPrice double

Discounted cost of product without taxes included

Optional, read only.
lineItems[].price.discountedPrice.grossPriceDiscountAmount double

Gross price discount amount

Optional, read only.
lineItems[].price.discountedPrice.netPriceDiscountAmount double

Net price discount amount

Optional, read only.
lineItems[].price.discountedPrice.signedDiscount string

Signed discount

Optional, read only.
lineItems[].price.discountedPrice.vatDiscountAmount double

VAT discount amount

Optional, read only.
lineItems[].price.grossPrice double

Cost of product with taxes included

lineItems[].price.netPrice double

Net price

lineItems[].price.vatAmount double

VAT amount (grossPrice - netPrice)

lineItems[].price.vatRate double

Sales tax rate

lineItems[].priceFunctionParameters object Optional
lineItems[].priceFunctionParameters.<key> map of string Optional
lineItems[].processingEvent[] array

History of processing events for this line item

Optional
lineItems[].processingEvent[].createDate int64

Date of creation

Optional, read only.
lineItems[].processingEvent[].error string

Error

Optional, read only.
lineItems[].processingEvent[].message string

Message

Optional, read only.
lineItems[].processingEvent[].metadata object Optional
lineItems[].processingEvent[].name string

Name

Read only.
lineItems[].processingEvent[].source string

Source

Optional, read only.
lineItems[].processingEvent[].status string

Status

Optional, read only.
lineItems[].processingStatus string

Processing status for this line item

Possible values are:

  • CANCELED
  • PARTIALLY_CANCELED
  • FAILURE
  • PENDING
  • COMPLETED
  • INITIALIZED
Optional, read only.
lineItems[].productFamily string Optional
lineItems[].productId string

Internal reference ID of product service

lineItems[].publisherFulfillmentId string

Publisher fulfillment ID

Optional
lineItems[].publisherRefId string

Publisher product ID

Optional
lineItems[].relatedContents[] array

Links for downloading product-related content file

Optional
lineItems[].relatedContents[].file string

URL or file name with extension for downloading

Optional
lineItems[].relatedContents[].label string

Explanation of what this binary is

Optional
lineItems[].signedProduct string Optional
lineItems[].subscriptionId string

Subscription ID

Optional
lineItems[].subscriptionProcessingStatus string

Subscription processing status for this line item

Possible values are:

  • NONE
  • INITIALIZED
  • CREATION_PENDING
  • CREATION_FAILURE
  • CREATION_ACCEPTED
  • CANCEL_PENDING
  • CANCEL_FAILURE
  • CANCEL_ACCEPTED
Optional, read only.
lineItems[].subscriptionTemplate string

Subscription template name

Optional
lineItems[].variables object

Product variables

Optional
lineItems[].vatAmount double

VAT amount (grossPrice - netPrice)

lineItems[].vatRate double

Product VAT rate

parentOrderId string

Parent order reference ID

Optional
payment object Payment Optional
payment.methodId string

ID of payment method in end-user wallet used to process payment

Optional
payment.methodType string

Payment type used (Visa, PayPal, etc.)

Optional
payment.transactionId string

Reference ID of the payment service

Optional
payment.vendor string

Payment vendor

Optional
paymentMethodId string

ID of payment method in end-user wallet to use to process payment

Optional
paymentStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • FRAUD_PENDING
  • PENDING
  • FAILED
  • COMPLETED
  • CANCELED
Optional
processingEvent[] array

List of order processing events

Optional
processingEvent[].createDate int64

Date of creation

Optional, read only.
processingEvent[].error string

Error

Optional, read only.
processingEvent[].message string

Message

Optional, read only.
processingEvent[].metadata object Optional
processingEvent[].name string

Name

Read only.
processingEvent[].source string

Source

Optional, read only.
processingEvent[].status string

Status

Optional, read only.
registerPaymentMethodStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • FRAUD_PENDING
  • PENDING
  • FAILED
  • COMPLETED
  • CANCELED
Optional
retailers[] array

List of retailers

Optional
retailers[].id string Optional
retailers[].marketPay object MarketPay Optional
retailers[].marketPay.accountCode string Optional
retailers[].remittance object Remittance Optional
retailers[].remittance.rate double Optional
retailers[].remittanceAmount double Optional
retailers[].storeId string Optional
salesFlag[] array of string Optional
salesFlags[] array of string

List of sales flags

Optional
source string

Order source: PURCHASE or SUBSCRIPTION (empty means PURCHASE)

Possible values are:

  • PURCHASE
  • SUBSCRIPTION
Optional, read only.
status string

Status

Possible values are:

  • CANCELED_WITH_ERROR
  • CANCEL_PENDING
  • CANCELED
  • PARTIAL_CANCELED
  • PARTIAL_COMPLETED
  • COMPLETED
  • PENDING_WITH_ERROR
  • PENDING
  • FRAUD_PENDING
  • PAYMENT_PENDING
  • CREATED
Optional, read only.
store object Store Optional
store.allowOrderDetailsOnCheckoutConfirmation boolean Optional
store.bannerInvoice string

Invoice banner

Optional
store.bannerOrderConfEmail string

Order confirmation banner

Optional
store.hostnames[] array of string

List of hostnames used by store

Optional
store.id string

Reference ID of store service

store.name string

Name

Optional
storeHostname string

Store hostname

Optional
subscriptionStatus string

Possible values are:

  • NONE
  • INITIALIZED
  • CREATION_PENDING
  • CREATION_FAILURE
  • CREATION_ACCEPTED
  • CANCEL_PENDING
  • CANCEL_FAILURE
  • CANCEL_ACCEPTED
Optional
subsidiaryId string

Subsidiary reference ID

Optional
totalAmount double

Total amount

transactionId string

Reference ID of payment service

Optional
updateDate date-time Optional
vatRate double

VAT rate

Example

{
    "allowPaymentMethodRegistration": false,
    "consentFlags": {
        "newsletterOptin": false
    },
    "customer": {},
    "endUser": {
        "company": {}
    },
    "fullTotalAmount": {
        "discountedPrice": {}
    },
    "invoice": {},
    "payment": {},
    "store": {}
}