Get Orders

Summary of Changes: (The purpose of this table is to keep traceability and Product team to highlight the things that were changed into the scope, based on comments or discussions)

Get new orders and modified order will be controlled by single cron since we can filter the order by updated date. The first run of the cron should look for order in the last 90 days and every next run to overlap with 60 minutes the date of the last run.

Search orders using a set of filters

Try it

Use this method to retrieve a list of orders using a set of filters.

You may filter your search by adding the following criteria in your request body:

• A list of order status
• An order reference
• A business order
• A shipping country
• A supply mode
• A sales channel identifier
• A time range using min/max criteria on the orders’ creation or last update dates

You may also sort your search by date using the following fields:

• Shipping date
• Created date
• Last updated date

To ensure a faster answer, the number of items retrieved per page is limited to a 100 items.

API Call:GET https://api.octopia-io.net/seller/v2/orders API Docs:https://developer.octopia-io.net/api-details#api=api-rest-seller-v2&operation=get-orders

Request parameters

Sample Request: GET https://api.octopia-io.net/seller/v2/orders?pageIndex=1&pageSize=100&updatedAtMin=2022-11-15T22:00:00.000Z&updatedAtMax=2022-11-22T22:00:00.000Z

Sample Response:

{
    "itemsPerPage": 50,
    "items": [{
        "orderId": "SCID01210525142759UT8E",
        "reference": "2105251416839",
        "businessOrder": true,
        "salesChannel": {
            "id": "SCID01",
            "name": "MY SALES CHANNEL"
        },
        "seller": {
            "id": "98797"
        },
        "customer": {
            "reference": "CUST37764GF3"
        },
        "purchasedAt": "2021-05-25T13:28:37Z",
        "updatedAt": "2021-06-07T11:32:59Z",
        "createdAt": "2021-05-25T14:27:59Z",
        "status": "Cancelled",
        "payment": {
            "Method": "Card"
        },
        "currencyCode": "Eur",
        "billingAddress": {
            "civility": "Mr",
            "firstName": "Thomas",
            "lastName": "Schmidt",
            "companyName": "Die Kleine Fabrik",
            "companyRegistrationNumberType": "DUNS",
            "companyRegistrationNumber": "123456789",
            "companyVatNumber": "DE09999999XX",
            "addressLine1": "Mauerstrasse 31",
            "addressLine2": "Gebaeude A2",
            "addressLine3": "Wohnung 213",
            "postalCode": "10117",
            "city": "Berlin",
            "stateOrRegion": " ",
            "countryCode": "De"
        },
        "totalPrice": {
            "offerPrice": 130.97,
            "sellingPrice": 130.97
        },
        "statusEvents": [{
            "date": "2022-06-14T22:00:59Z",
            "status": "Cancelled"
        }],
        "lines": [{
            "orderLineId": "1RT2",
            "status": "Cancelled",
            "quantity": 3,
            "totalPrice": {
                "offerPrice": 130.97,
                "sellingPrice": 130.97
            },
            "offerPrice": {
                "unitSalesPrice": 41.99,
                "shippingCost": 5,
                "commission": {
                    "amountWithVat": 80,
                    "rate": 20
                },
                "taxes": [{
                    "code": "VAT",
                    "target": "shippingFees",
                    "amount": 0,
                    "rate": 0
                }]
            },
            "sellingPrice": {
                "unitSalesPrice": 41.99,
                "shippingCost": 5,
                "taxes": [{
                    "code": "VAT",
                    "target": "shippingFees",
                    "amount": 0,
                    "rate": 0
                }]
            },
            "offer": {
                "id": "XooAzb123_98797_6_SCID01",
                "supplyMode": "Fulfillment",
                "productId": "XooAzb123",
                "productTitle": "Nintendo Switch Lite Gray Console",
                "sellerProductId": "98797_abc123",
                "condition": "New"
            },
            "delivery": {
                "mode": "Standard",
                "promisedAtMin": "2021-05-28T13:28:37.814Z",
                "promisedAtMax": "2021-06-28T13:28:37.814Z",
                "shippedAtMin": "2021-06-01T13:28:37.814Z",
                "shippedAtMax": "2021-05-27T13:28:37.814Z"
            },
            "shippingAddress": {
                "civility": "Mr",
                "firstName": "Thomas",
                "lastName": "Schmidt",
                "companyName": "Die Kleine Fabrik",
                "addressLine1": "Mauerstrasse 31",
                "addressLine2": "Gebaeude A2",
                "addressLine3": "Wohnung 213",
                "postalCode": "10117",
                "city": "Berlin",
                "stateOrRegion": " ",
                "countryCode": "De",
                "phone": "0611223344",
                "email": "a@a.aa",
                "latitude": 0,
                "longitude": 0
            },
            "cancellationDetails": {
                "requestedBy": "Seller",
                "reason": "Seller-refusal"
            },
            "parcels": [{
                "number": "12QDS0",
                "carrierName": "DHL",
                "trackingUrl": "https://DHL.com/tracking?id=12QDS0",
                "trackingId": "deabfa7c-e6ef-4832-bcee-444398f23e0c"
            }],
            "statusEvents": [{
                "date": "2021-05-28T13:28:37Z",
                "status": "Cancelled"
            }],
            "productAttributes": {}
        }]
    }]
}

Response Mapping:

Order Status Mapping

Hemi Status Transitions