Envíos

Crea un envío

Este endpoint permite crear un envío, usando la cotización creada (POST /api/v1/quotations) y obtenida previamente (GET /api/v1/quotations/{id}).

post/api/v1/shipments/

Request

  • Base URL: https://api-pro.skydropx.com
  • URL: https://api-pro.skydropx.com/api/v1/shipments/
  • Auth: HTTP bearer

Request body

OR

Example request

{
  "shipment": {
    "rate_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "original_shipment_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "printing_format": "thermal",
    "address_from": {
      "address_template_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "street1": "Calle Example",
      "street_number": "123",
      "name": "Homero Simpson",
      "company": "Acme INC",
      "phone": "4434434445",
      "email": "homero@simpson.com",
      "reference": "Casa de Homero",
      "further_information": "Dejar con el vecino",
      "tax_id_number": "XAXX010101000"
    },
    "address_to": {
      "address_template_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "street1": "Avenida Example",
      "street_number": "456",
      "name": "Bart Simpson",
      "company": "Example Company LTDA.",
      "phone": "4434434444",
      "email": "bart@simpson.com",
      "reference": "Casa de Bart",
      "further_information": "Dejar con el vecino",
      "tax_id_number": "123456789"
    },
    "packages": [
      {
        "package_number": "1",
        "package_protected": true,
        "declared_value": 2500,
        "consignment_note": "53102400",
        "package_type": "4G",
        "products": [
          {
            "product_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "name": "Producto 1",
            "description_en": "Product description",
            "quantity": 1,
            "price": 100,
            "sku": "SKU-123",
            "hs_code": "9706.900060",
            "hs_code_description": "Descripción del HS Code",
            "product_type_code": "P",
            "product_type_name": "Producto",
            "country_code": "MX"
          }
        ]
      }
    ]
  }
}

Response

Retorna el envío creado

Example response

{
  "data": {
    "id": "0ac5adcc-a13d-427d-81dd-9ddd70b2f660",
    "attributes": {
      "id": "0ac5adcc-a13d-427d-81dd-9ddd70b2f660",
      "carrier_name": "fedex",
      "workflow_status": "pending",
      "payment_status": "paid",
      "total": "38.20",
      "source": "api",
      "carrier_id": "0ac5adcc-a13d-427d-81dd-9ddd70b2f660",
      "service_id": "0ac5adcc-a13d-427d-81dd-9ddd70b2f660",
      "master_tracking_number": "1234567890",
      "original_shipment_id": "0199977a-e032-78bf-a335-00a9ae3cfdff",
      "office_delivery_point_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "office_pickup_point_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "error_detail": {
        "error_code": "ERR_INVALID_ADDRESS",
        "error_message": "La dirección de destino no es válida",
        "error_message_detail": "Token no válido"
      },
      "order_detail_url": "https://api.example.com/rails/active_storage/blobs/.../order_details.pdf"
    }
  },
  "included": [
    {
      "attributes": {
        "id": "0ac5adcc-a13d-427d-81dd-9ddd70b2f660",
        "package_type": "4G",
        "tracking_url_provider": "https://www.fedex.com/fedextrack/?trknbr=234234234233",
        "tracking_status": "created",
        "label_url": "https://label.com"
      }
    }
  ]
}

Changes

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