From 3c6b38ebc93e1f4c1d6f6f85e9e7e1d6c81ca08f Mon Sep 17 00:00:00 2001 From: Holly Abrams Date: Fri, 14 Aug 2026 10:05:14 -0400 Subject: [PATCH 1/2] Adding ReadyDocs cURL and response snippets --- .../docs/curl/current/readydocs/create.sh | 118 ++++++++++++++++++ .../responses/readydocs/readydocs-create.json | 11 ++ 2 files changed, 129 insertions(+) create mode 100644 official/docs/curl/current/readydocs/create.sh create mode 100644 official/docs/responses/readydocs/readydocs-create.json diff --git a/official/docs/curl/current/readydocs/create.sh b/official/docs/curl/current/readydocs/create.sh new file mode 100644 index 00000000..07421965 --- /dev/null +++ b/official/docs/curl/current/readydocs/create.sh @@ -0,0 +1,118 @@ +curl -X POST https://api.easypost.com/readydocs/packslip \ + -u "EASYPOST_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{ +    "pack_slip_data": { +      "pack_slip": { +        "project": "hsn_8x11", +        "output_type": "S3", +        "order": { +          "ship_to": { +            "address": { +              "name": "Dr. Steve Brule", +              "company": "EasyPost", +              "street1": "417 Montgomery Street", +              "street2": "5th Floor", +              "city": "San Francisco", +              "state": "CA", +              "zip": "94104", +              "country": "US", +              "phone": "4155559999", +              "email": "dr_steve_brule@example.com" +            } +          }, +          "ship_from": { +            "address": { +              "name": "EasyPost", +              "company": "EasyPost", +              "street1": "417 Montgomery Street", +              "street2": "5th Floor", +              "city": "San Francisco", +              "state": "CA", +              "zip": "94104", +              "country": "US", +              "phone": "4155559999", +              "email": "support@example.com" +            } +          }, +          "bill_to": { +            "address": { +              "name": "Dr. Steve Brule", +              "street1": "179 N Harbor Dr", +              "city": "Redondo Beach", +              "state": "CA", +              "zip": "90277", +              "country": "US", +              "phone": "8575551212", +              "email": "dr_steve_brule@example.com" +            } +          }, +          "customer_service": { +            "phone": "4155559999", +            "email": "support@example.com", +            "website": "https://www.example.com" +          }, +          "customer_id": "customer_123", +          "customer_order": "order_123", +          "order_number": "123456", +          "po_number": "PO-123456", +          "invoice_number": "INV-123456", +          "warehouse_id": "warehouse_123", +          "ship_date": "08/11/2026", +          "order_date": "08/10/2026", +          "delivery_date": "08/14/2026", +          "ship_method": "Ground", +          "pay_method": "Credit Card", +          "order_message": "Thank you for your order.", +          "sub_total": "$25.00", +          "sales_tax": "$2.00", +          "shipping_handling": "$5.00", +          "credit": "$0.00", +          "total": "$32.00", +          "currency_uom": "$", +          "sales_person": "Steve Brule", +          "order_lines": { +            "line": [ +              { +                "item_id": "item_123", +                "upc": "012345678905", +                "merchant_sku": "SKU-123", +                "customer_part_number": "PART-123", +                "description": "T-shirt", +                "item_style": "Blue / Medium", +                "qty": { +                  "ord": 2, +                  "ship": 2, +                  "bo": 0, +                  "uom": "each" +                }, +                "unit_price": "$12.50", +                "total_price": "$25.00", +                "gift_message": "Happy Birthday!" +              } +            ] +          } +        }, +        "shipping_label": { +          "data": "test", +          "format": "PNG", +          "encoding": "base64" +        }, +        "print_commands": { +          "print": { +            "type": "text", +            "encoding": "base64", +            "encoding_character_set": "UTF-8", +            "data": "test", +            "size": "4x6", +            "format": "ZPL" +          } +        }, +        "image": { +          "char_set": "ISO-8859-1", +          "image_data": "/9j/4AAQS.......QhCA/", +          "image_format": "JPEG" +        } +      } +    } +  }' diff --git a/official/docs/responses/readydocs/readydocs-create.json b/official/docs/responses/readydocs/readydocs-create.json new file mode 100644 index 00000000..47773edb --- /dev/null +++ b/official/docs/responses/readydocs/readydocs-create.json @@ -0,0 +1,11 @@ +{ + "object": "Document", + "mode": "test", + "reference": null, + "status": "created", + "document_type": "packing_slip", + "format": "pdf", + "file_url": "https://eformz-doclib.s3.us-west-2.amazonaws.com/files/doclib/20260813/packslip_1786654215217.pdf", + "messages": [], + "created_at": "2026-08-13T20:50:14.870Z" +} From 9427c1fffc1b9747da96430eba238c3ab0f6cddb Mon Sep 17 00:00:00 2001 From: Holly Abrams Date: Fri, 14 Aug 2026 10:24:02 -0400 Subject: [PATCH 2/2] Fix: ReadyDocs example formatting --- official/docs/curl/current/readydocs/create.sh | 1 + .../responses/readydocs/readydocs-create.json | 18 +++++++++--------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/official/docs/curl/current/readydocs/create.sh b/official/docs/curl/current/readydocs/create.sh index 07421965..3c34fb72 100644 --- a/official/docs/curl/current/readydocs/create.sh +++ b/official/docs/curl/current/readydocs/create.sh @@ -1,3 +1,4 @@ +# shellcheck disable=SC2016 curl -X POST https://api.easypost.com/readydocs/packslip \ -u "EASYPOST_API_KEY" \ -H "Content-Type: application/json" \ diff --git a/official/docs/responses/readydocs/readydocs-create.json b/official/docs/responses/readydocs/readydocs-create.json index 47773edb..3f0254ee 100644 --- a/official/docs/responses/readydocs/readydocs-create.json +++ b/official/docs/responses/readydocs/readydocs-create.json @@ -1,11 +1,11 @@ { - "object": "Document", - "mode": "test", - "reference": null, - "status": "created", - "document_type": "packing_slip", - "format": "pdf", - "file_url": "https://eformz-doclib.s3.us-west-2.amazonaws.com/files/doclib/20260813/packslip_1786654215217.pdf", - "messages": [], - "created_at": "2026-08-13T20:50:14.870Z" + "object": "Document", + "mode": "test", + "reference": null, + "status": "created", + "document_type": "packing_slip", + "format": "pdf", + "file_url": "https://eformz-doclib.s3.us-west-2.amazonaws.com/files/doclib/20260813/packslip_1786654215217.pdf", + "messages": [], + "created_at": "2026-08-13T20:50:14.870Z" }