Ordenes

Recupera una orden (V2)

   GET /api/v2/orders/:id

Versión V2 del detalle de la orden. Devuelve parcels como arreglo (soporte multi-paquete) y agrega payment_status, package_type, consignment_note, dimension_unit, mass_unit y hs_code dentro de cada producto. Incluye además los campos para envíos internacionales shipment_purpose y customs_payment_payer a nivel de orden; declared_value, package_protected y package_number en cada paquete; y hs_code_description, description_en, product_type_code, product_type_name y country_code en cada producto. Estos campos siempre están presentes y son null cuando no aplican (órdenes nacionales).

get/api/v2/orders/{id}

Request

  • Base URL: https://api-pro.skydropx.com
  • URL: https://api-pro.skydropx.com/api/v2/orders/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Retorna una orden

Example response

{
  "data": {
    "id": "9e270243-762f-40c8-833e-ef1c4ee8282d",
    "type": "order",
    "attributes": {
      "id": "9e270243-762f-40c8-833e-ef1c4ee8282d",
      "reference": "188-5455445-33334433",
      "tags": [
        "tag1",
        "tag2"
      ],
      "platform": "Shopify",
      "ecommerce_id": "SDFG",
      "payment_status": "paid",
      "price": 10,
      "shipping_preferences": [
        {
          "service": "me2",
          "price": "100.00"
        }
      ],
      "payment_type": "COD",
      "shipment_purpose": "goods",
      "customs_payment_payer": "recipient",
      "created_at": "2025-01-07T14:46:38.203-06:00",
      "address_from": {
        "area_level1": "Nuevo León",
        "area_level2": "Monterrey",
        "area_level3": "La Finca",
        "name": "Name",
        "postal_code": "64000",
        "country_code": "MX",
        "street1": "Olivo 4618",
        "phone": "1242452456",
        "email": "email@example.com",
        "reference": "Green house",
        "address_type": "from",
        "tax_id_number": "XAXX010101000",
        "tax_id_type": "rfc"
      },
      "address_to": {
        "area_level1": "Monterrey Centro",
        "area_level2": "Monterrey",
        "area_level3": "La finca",
        "name": "Mayra Doe",
        "postal_code": "64000",
        "country_code": "MX",
        "street1": "22 Main St",
        "company": "ACS Inc.",
        "phone": "1234567890",
        "email": "jhon@doe.com",
        "reference": "Near the park",
        "address_type": "to",
        "apartment_number": "123",
        "tax_id_number": "XAXX010101000",
        "tax_id_type": "rfc"
      },
      "parcels": [
        {
          "weight": 2,
          "length": 10,
          "width": 10,
          "height": 10,
          "declared_value": 120.5,
          "package_number": 1,
          "package_type": "4G",
          "consignment_note": "24121500",
          "dimension_unit": "cm",
          "mass_unit": "kg",
          "products": [
            {
              "id": "c2092234-1b85-41a2-a200-858d052c0ad1",
              "name": "Bicicleta",
              "sku": "BIC-001",
              "hs_code": "9560.63",
              "hs_code_description": "Bicycles",
              "description_en": "Mountain bike",
              "product_type_code": "60141200",
              "product_type_name": "Bicycles",
              "country_code": "MX",
              "quantity": 1,
              "price": 57,
              "weight": 10,
              "height": 10,
              "width": 10,
              "length": 10
            }
          ]
        }
      ]
    },
    "relationships": {
      "shipments": {
        "data": [
          {
            "id": "9eae25ba-11b4-4b9f-9b01-3d09da8bc12d",
            "type": "shipment"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "9eae25ba-11b4-4b9f-9b01-3d09da8bc12d",
      "type": "shipment",
      "attributes": {
        "carrier_name": "fedex",
        "workflow_status": "completed"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.