GET
/
openapi
/
v1
/
SalesOrders
/
{referenceNumber}
Get SalesOrder by referenceNumber.
curl --request GET \
  --url https://api.oplog.one/openapi/v1/SalesOrders/{referenceNumber} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "referenceNumber": "<string>",
  "salesChannel": "<string>",
  "approvedShipments": true,
  "state": "Cancelled",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "orderCreatedAt": "2023-11-07T05:31:56Z",
  "pickedAt": "2023-11-07T05:31:56Z",
  "packedAt": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "shippedAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "customer": {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerNo": 123,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "shippingAddress": {
    "addressNo": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "addressFirstName": "<string>",
    "addressLastName": "<string>",
    "company": "<string>",
    "addressOne": "<string>",
    "addressTwo": "<string>",
    "district": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "addressPhone": "<string>",
    "taxOffice": "<string>",
    "taxNumber": "<string>"
  },
  "billingAddress": {
    "addressNo": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "addressFirstName": "<string>",
    "addressLastName": "<string>",
    "company": "<string>",
    "addressOne": "<string>",
    "addressTwo": "<string>",
    "district": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "addressPhone": "<string>",
    "taxOffice": "<string>",
    "taxNumber": "<string>"
  },
  "shippingInfo": {
    "shippingCompany": "<string>",
    "shippingTrackingId": "<string>",
    "shippingState": "<string>",
    "trackingUrl": "<string>"
  },
  "lineItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sku": "<string>",
      "barcodes": [
        "<string>"
      ],
      "salePrice": 123,
      "currency": "TRY",
      "imageUrl": "<string>",
      "productName": "<string>",
      "productType": "Product",
      "productCategory": "<string>",
      "amountInOrder": 123,
      "missingQuantity": 123,
      "cancelledAmount": 123,
      "productSalePrice": 123,
      "productTaxRatio": 123,
      "productDiscount": 123
    }
  ],
  "integration": {
    "integrationType": "CudExcludedIntegrations",
    "integrationName": "<string>"
  },
  "payment": {
    "paymentOption": "Paid",
    "totalPaymentAmount": 123,
    "currency": "TRY"
  },
  "cargo": {
    "requestedCargoCarrier": "<string>",
    "cargoDocumentUrl": "<string>",
    "cargoCode": "<string>",
    "cargoType": "RegularDelivery"
  },
  "vas": {
    "packageNote": "<string>",
    "gift": {
      "wrap": true,
      "notes": "<string>"
    },
    "document": {
      "documentUrl": "<string>"
    }
  },
  "packages": [
    {
      "referenceNumber": "<string>",
      "state": "Cancelled",
      "invoiceURL": "<string>",
      "lineItems": [
        {
          "sku": "<string>",
          "barcodes": [
            "<string>"
          ],
          "amountInPackage": 123,
          "serialNumbers": "<string>",
          "productSalePrice": 123,
          "productTaxRatio": 123,
          "productDiscount": 123
        }
      ],
      "shippingInfo": {
        "shippingCompany": "<string>",
        "shippingTrackingId": "<string>",
        "shippingState": "<string>",
        "trackingUrl": "<string>"
      }
    }
  ],
  "approved": true
}

Authorizations

Authorization
string
header
required

Headers

X-Tenant-Id
string

If you want to emulate, please enter TenantId.

Path Parameters

referenceNumber
string
required

Response

Success

id
string<uuid>
referenceNumber
string
salesChannel
string
approvedShipments
boolean
state
enum<string>
Available options:
Cancelled,
Created,
Picked,
Packed,
ReadyToBeShipped,
Shipped,
Delivered
createdAt
string<date-time>
updatedAt
string<date-time>
orderCreatedAt
string<date-time>
pickedAt
string<date-time>
packedAt
string<date-time>
cancelledAt
string<date-time>
shippedAt
string<date-time>
deliveredAt
string<date-time>
customer
object
shippingAddress
object
billingAddress
object
shippingInfo
object
lineItems
object[]
integration
object
payment
object
cargo
object
vas
object
packages
object[]
approved
boolean