API Support: accounts@resolvepay.com
Legacy (v2) API documentation: https://app.resolvepay.com/docs/api/v2
The Resolve API is organized around REST principles. It uses predictable resource-oriented URLs, standard HTTP verbs and response codes, and accepts and returns JSON-encoded request and response bodies.
Resolve offers both server-side and client-side integrations. This documentation refers to the server-side API. Refer to our e-commerce plugin guides for details on client-side checkout solutions.
There is a sandbox API available for testing, which leverages the same data store as your sandbox dashboard. Testing on sandbox won't affect your live data or create money movements.
| Environment | Base URL |
| Production | https://app.resolvepay.com/api/ |
| Sandbox | https://app-sandbox.resolvepay.com/api/ |
Before using the API, reach out and get your Resolve account created. This account enables access to the credentials that are necessary for API access.
Resolve uses HTTP basic authentication where the username refers to your merchant ID, and the password refers to your secret API key.
When backwards-incompatible changes are released, a new, dated version is released. The current version is V5. You can upgrade the version of the api that your account uses within your merchant settings.
Legacy (v2) API documentation may be found here.
All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list customers, list invoices.
These list API methods share a common structure, taking at least two parameters: limit and page.
count - represents total amount of records, satisfying the request query.page - a multiplier value, which gets applied to the limit and shows what position records are being returned from. For example, if limit = 20 and page = 5, then maximun 20 records will be returned from position 5 * 20 = 100.limit - maximun amount of records, which can be returned.results - array of records being returned. If no records satisfy request condition, the array will be empty.To ensure platform reliability and fair use, Resolve implements rate limits for the REST API.
Resolve APIs use the Sliding Window algorithm to monitor and control request rates with a 100 requests/minute limit. The API will return a 429 Too Many Requests status if the amount of requests exceeds rate limits.
All responses from Resolve APIs will include the following headers:
X-Ratelimit-Limit: The maximum amount of requests permitted within a 60-second period.X-Ratelimit-Remaining: The remaining requests within the current period.X-Ratelimit-Reset: A UNIX timestamp indicating when the rate limit period will reset.X-Ratelimit-Limit and X-Ratelimit-Remaining response headers in your application to avoid surpassing rate limits.429 status code.The invoice represents the business transaction between you and your customer. In Resolve, an invoice must be tied to a customer and an advance can be taken on the invoice.
For an advance to be taken on the invoice, a PDF of the invoice must be uploaded and the associated customer must be approved and have available credit for the amount of the invoice.
A customer represents a company that you do business with. For larger companies, there may be several users with access to the customer account that can make purchases with their credit line. For smaller companies, a customer may represent a single individual. Retrieve a customer to get a summary of their total credit line and available credit balance.
Payout Transactions are the individual transactions like customer payments, Resolve advances, forwarded payments, etc. that are rolled into a Payout. Each Payout is the sum of one or more transactions. Note that certain fields are only relevant to certain transaction types - e.g.: a Payout Transaction of type monthly_fee will have both customer_id and invoice_id set to null.
A payment represents a transaction where a customer pays towards their invoices. When a payment is made to Resolve, the customer's available credit balance is increased by the amount of the payment. Payments can be made via various methods including ACH, credit card, check, or wire transfer. Each payment can be applied to one or more invoices.
A shipment represents the fulfillment of goods or services for an invoice. Track shipments to monitor delivery status and fulfillment progress. Shipments can be fulfilled through various methods including shipping providers, self-delivery, customer pickup, or for services-only transactions.
While any courier value can be accepted for the shipment_courier field, instant verification through the sync endpoint is supported for the following couriers:
fedex, ups, usps, 17postservice, 2go, 2ebox, 360lion, 3jmslogistics, 4-72, 4px, shipstoresoftware-webhook, 99minutos, aduiepyle, a1post, a2b-ba, aaa-cooper, abf, acilogistix, acscourier, acsworldwide, ads, adsone, aex, afllog-ftp, arihantcourier, air21, aitworldwide-sftp, aitworldwide-api, alljoy, amsegroup, ancdelivers-sftp, anserx, ao-deutschland, ao-courier, ao-courier-webhook, apc-overnight, apc-overnight-connum, apc, apg, ark-logistics, ase, asigna, asm, ata, atshealthcare, atshealthcare-reference, activos24-api, aderonline, adicional, aeronet, test-courier, agediss-sftp, agility, airmee-webhook, airpak-express, airspeed, allegro, alliedexpress, allied-express-ftp, alphafreight-webhook, always-express, amazon, awest, an-post, andreani-api, anicamboxexpress, anjun, anteraja, aoyue, aquiline, aramex, aramex-api, fastway-au-api, fastway-au, araskargo, arco-spedizioni, argents-webhook, arrow-api, arrowxl, asendia-de, asendia-hk, asendia, asendia-uk, asendia-usa, agsystems, associated-couriers, asyadexpress, auexpress, australia-post, australia-post-api, austrian-post, austrian-post-registered, averitt, axlehire, axlehire-ftp, bh-worldwide, b2ceurope, bdmnet, bjshomedelivery, bjshomedelivery-ftp, brt-it, brt-it-api, brt-it-parcelid, brt-it-sender-ref, btxglobal-ftp, buffalo, barqexp, barsan, belpost, ibeone, bert-fr, 800bestex, besttransport-sftp, bestwayparcel, bettertrucks, bigsmart, biocair-ftp, birdsystem, bleckmann-sftp, blinklastmile, bluex, bluestar, bluecare, bluedart-api, bluedart, bneed, bollore-logistics-sftp, bollore-logistics, bombinoexp, bomi-br-api, bomi, bond, bondscouriers, borderexpress, borderless360-webhook, boxc, box-berry, boxcheck-api, bpost, bpost-api, bpost-international, braspress-web, braunsexpress, brazil-correios, bring, bringer, brouwer-transport, budbee-webhook, bgpost, burd, cchezvous-sftp, cae-delivers, cbl-logistica, cbl-logistica-api, cdek, cdek-tr, cdldelivers, cdldelivers-api, ceva, ceva-webhook, ceva-tracking, cfl-logistics, cgs-express, parcll, cj-malaysia-international, cj-gls, cj-korea-thai, cjlogistics, cj-hk-international, cjpacket, cj-philippines, ckb-webhook, cle-logistics, cn-logistics, cnexps, crlexpress, cse, ctc-express, tourline, cacesa, cago, cainiao, cambodia-post, canada-post, canpar, capital, cpex, cargopartner-api, carriers, carry-flap, castleparcels, celeritas-ftp, cello-square, champion-logistics, chazki, chienventure-webhook, chilexpress-webhook, china-ems, china-post, chitchats, choirexpress, chronopost-france-webhook, chronopost-france, chronopost-portugal, ec-firstclass, city56-webhook, citylinkexpress, clevy-links, clicklink-sftp, cloudwish-asia, colis-prive, colissimo, collectplus, collectco, com1express, comet-tech, con-way, concise-api, concise-webhook, continental, coordinadora, coordinadora-api, copa-courier, cope, corporatecouriers-webhook, correo-uy, correosexpress, correosexpress-api, spain-correos-es, correos-de-mexico, costmeticsnow, courant-plus, courant-plus-api, courierit, cnwglobal-api, courier-plus, courierpost, couriers-please, croshot, crossflight, cryopdp-ftp, cubyn, cuckooexpress, cyprus-post, ceskaposta, ceskaposta-api, dexpress-webhook, dachser-web, dachser, daiglobaltrack, dao365, dbschenker-se, dbschenker-api, dbschenker-b2b, dbschenker-iceland-ftp, dbschenker-sv, ddexpress, deliveryontime, dex-i, dhl-api, dhl-reference-api, dhl-active-tracing, dhl-benelux, dhl-sftp, dhl, dhl-pieceid, dhl-freight, dhl-pa-api, dhl-global-forwarding-api, dhl-gt-api, dhl-ecommerce-gc, dhl-ecommerce-gc-api, dhl-hk, dhl-ie-sftp, dhl-nl, dhlparcel-nl, dhlparcel-ru, dhlparcel-es, dhlparcel-uk, dhl-poland, dhl-es-sftp, dhl-es, dhl-supplychain-apac, dhl-supply-chain-au-sftp, dhl-supply-chain-au, dhl-supplychain-id, dhl-global-mail-asia, dhl-global-mail-asia-api, dhl-global-mail, dhl-global-mail-api, dhl-supplychain-in, didadi, dirmensajeria, dksh, dmfgroup, dms-matrix, dnj-express, domino, dpd, dpd-api, dpd-at, dpd-at-sftp, exapaq, dpd-de, dpd-hk, dpd-hungary-web, dpd-hungary-ftp, dpd-hungary, dpd-ireland, interlink-express, interlink-express-reference, dpd-nl-api, packs-api, dpd-nl, dpd-poland, dpd-prt, dpd-ro, dpd-ru-api, dpd-ru, dpd-sk-sftp, dpd-ch-sftp, dpd-uk, dpd-uk-sftp, dpe-express, dpe-za, dpex, szdpex, dsv-za-sftp, dsv, dsv-reference, dsv-are-webhook, dtd, dtdc-au, dtdc-express, dtdc, dx, dx-sftp, dx-b2b-connum, dx-freight, daeshin, daiichi, danniao, danske-fragt, dashlink-webhook, dawnwing, dayross, dylt, dayton-freight, dealer-send, delhivery-webhook, delhivery, deliveryourparcel-za, deliver-it, smartkargo, deliveright-webhook, deliverr-sftp, delnext, deltec-courier, godependable, designertransport-webhook, destiny-ftp, destiny, destiny-webhook, detrack, detrack-webhook, dhl-germany, deutsch-post, dialogo-logistica-api, dialogo-logistica, diamondcouriers, dimerco, directcouriers, directcouriers-ftp, directfreight-au-ref, directlog, direx, discountpost, emega, dobropost, doordash-webhook, doora, dynamic-logistics, ecms, ecoscooting, ecexpress, efs, elta-courier, empsexpress, ems, eu-fleet-solutions, myhermes-uk, myhermes-uk-api, ewe, expressone, expressone-sv, earlybird, eastwestcourier-ftp, easy-mail, easyroutes, easyparcel, ecargo-asia, echo, ecofreight, ecom-express, ekart, ekol-api, elite-co, emirates-post, endeavour-delivery, energologistic, envialia, envialia-reference, equick-cn, eshipping, zes-express, estafeta, estafeta-api, estes, efwnow-api, etomars, edf-ftp, eurodis, europaket-api, exelot-ftp, expeditors, expeditors-api-ref, expresssale, fan, far-international, fdsexpress, fercam, fmx, frontdoorcorp, fujexp, fargood, fnf-za, fastdespatch, fastbox, fastrak-th, fastship, fasttrack, aramex-au-api, fastway-ireland, fastway-nz, fastway-za, faxecargo, fetchr, fiege, fiege-nl, first-flight, first-logistics-api, firstmile, fitzmark-api, flashexpress, flashexpress-webhook, flashexpress-ph-api, fleetopticsinc, flightlg, flipxp, fliway-sftp, fliway-api, flytexpress, fonsen, forwardair, fragilepak-sftp, freightquote, freterapido, fukuyama-sftp, fulfilla, fulfillmen, furdeco, gwlogis-api, gac-webhook, gangbao, gba, gbs-broker, gcx, gdex, gdpharm-webhook, gdpharm, gemworldwide, geodis-api, geodis-sftp, geodis-calberson-fr, geswl, gio-ecourier-api, gio-ecourier, gls, gls-croatia, gls-cz, gls-slovakia, gls-hun-api, gls-hun, gls-italy-ftp, gls-italy, dicom, gls-netherlands, gls-netherlands-webhook, gls-netherlands-sftp, gls-romania, gls-slovenia, gls-spain, gls-spain-api, gls-us, gols, gps, gsi-express, gso, gtagsm, gati-kwe, gati-kwe-api, gw-world, geis, gel-express, taxydromiki, geodis-usa-api, gpost, ghn, goglobalpost, globaltranz, globavend, globegistics, glovo, general-overnight, general-overnight-ftp, gopeople, gorush, gobolt, gojavas, gojek-webhook, grab-webhook, grandslamexpress, greyhound, mazet, grupoampm, andreani, hct-logistics, hfd, hkd, hrparcel, hermes-it, hsdexpress, hsm-global, htdkgroup-webhook, yycom, hubbed, hx-express, hdb, hdb-box, hanjin, hellenic-post, hellmann, helthjem, helthjem-api, heppner-fr, heppner, hermes-2mann-handling, hermes-de, hermes-de-ftp, hermes-uk-sftp, hermes, heroexpress, hipshipper, holisol, home-delivery-solutions, homelogistics, hong-kong-post, houndexpress, hrvatska-posta, hh-exp, huantong, hunter-express-sftp, hunter-express, huodull, ibventure-webhook, icscourier, idexpress, iml, imxmail, indopaket, intersmarttrans, intex-de, iordirect, postur-is, ilyanglogis, inpost-uk, inpost-paczkomaty, intime-ftp, india-post, india-post-int, inexpost, nox-nachtexpress, nox-nachtexpress-ftp, descartes, inntralog-sftp, instabox-webhook, integra2-ftp, intel-valley, intelcom-ca, intelipost, international-seur, international-seur-api, intexpress, interparcel-au, interparcel-nz, interparcel-uk, israel-post, israel-post-domestic, italy-sda, ivoy-webhook, jtcargo, jtexpress, jtexpress-ph, jtexpress-sg-api, simplypost, jtexpress-vn, j-net, jamef-web, jcex, jd-worldwide, jinsung, jne, jne-api, bh-posta, js-express, jx, jam-express, janco, janio, japan-post, javit, jawar, jayonexpress, jersey-post, jet-ship, ltianexp, jocom, joom-logistics, joyingbox, jumppoint-api, jumppoint, k1-express, kec, abxexpress-my, kgmhub, kurasi, kwe-global, kangaroo-my, kargomkolay, kedaex, kerryttc-vn, tgx, kerry-express-tw-api, kerry-logistics, kerry-express-th-webhook, kerrytj, kerry-ecommerce, kng, logisystems-sftp, kinisi, kiwi-express-webhook, kolay-gelsin, komon-express, kpost, korea-post, kronos-webhook, kronos, ky-express, kn, kdexp, lbcexpress-ftp, lbcexpress-api, lctbr-api, lht-express, liccardi-express, liefergrun, lmparcel, ltl, la-poste-colissimo, lalamove-api, lalamove, lalamove-plus-api, landmark-global-ftp, landmark-global, lao-post, lasership-api, lasership, latvijas-pasts, leader, legion-express, leman, lexship, lietuvos-pastas, line, linkbridge, lion-parcel, livrapide, locus-webhook, loggi, logisters, lwe-hk, logoix, logwin-logistics, logysto, lonestar, loomis-express, lotte, luwjistik, m-xpress, mx-cargo, m24logistics-webhook, m3logistics, mbw, collivery, metabrasil-webhook, misumi-cn, mng-kargo, mnx, mrw-spain, mrw, mrw-ftp, mudita, madrooex, maergo, magyar-posta-api, mail-box-etc, mailamericas, mailplus, mailplus-jp, mainfreight, mainway, malaysia-post-posdaftar, malaysia-post, malca-amit-api, malca-amit, marken, matdespatch, matkahuolto, medafrica, meest, fetchr-webhook, mensajerosurbanos-api, mwd-api, mwd, aeroflash, mexico-redpack, mexico-senda-express, mhi, mikropakket, mikropakket-be, milkman, mobi-br, mobiletyreshop-webhook, mondialrelay, mondialrelay-fr, mondialrelay-es, moova-webhook, moovin, morelink, morning-express, morninglobal, mothership-api, movianto, multientregapanama, mydynalogic, nmtransfer, nacex, nacex-spain-reference, nacex-spain, nox-night-time-express, ntilogistics-ftp, ntl, nytlogistics, new-zealand-post, naeko-ftp, nanjingwoyuan, naqel-express, national-sameday, nationex, nationex-ftp, nationwide-my, navlungo, netlogixgroup, newzealand-couriers, neweggexpress, newgistics, newgisticsapi, nhans-solutions, ntlogistics-vn, nipost, nightline, nim-express, nimbuspost, ninjavan, ninjavan-id, ninjavan-my, ninjavan-thai, ninjavan-vn, ninjavan-webhook, nippon-express-ftp, nippon-express, norsk-global, northline, nova-poshta, nova-poshtaint, nova-poshta-api, novofarma-webhook, oca-ar, ocs, ocs-worldwide, omlogistics-api, osm-worldwide-sftp, osm-worldwide, otschile, oakh, obibox, okayparcel, old-dominion, shopolive, omniparcel, omnirps-webhook, omniva-api, omniva, onway-webhook, ontrac, ontrac-api, oneworldexpress, oneclick, optimacourier, orangeconnex, orangeconnex-ftp, orangedsinc, orangedsinc-ftp, overseas-hr, ozeparts-shipping, p2p-delivery-api, trakpak, packfleet, palexpress, parcelone, pfcexpress, pflogistics, pflogistics-ftp, phse-api, pickupp-mys, pickupp-sgp, piggyship, pil-logistics, pittohio, taqbin-taiwan, mglobal, pts, ptt-kargo, ptt-posta, paack-webhook, pack-up, packaly, packeta, packlink, packs, paikeda, pakajo, palletways, pan-asia, pandago-api, pandago-ph-api, pandion, pandulogistics, panther, panther-order-number, panther-reference, panther-reference-api, papa-webhook, paper-express, paquetexpress, parcalogistics-webhook, parcalogistics-api, pdn-api, portless-api, parcel-force, parcelpost-sg, parcelright, parceltopost, parcel2go, parcelpal-webhook, parcelpoint, parcelinklogistics, parcelled-in, parcelstars-webhook, parcelstars, parknparcel, passportshipping, patheon, ppbyb, payo, payo-webhook, pgeon-api, pickrr, pickup, pidge, pilot-freight, pitney-bowes, planzer, plycongroup, poczta-polska, polarspeed, pony-express, porterex-webhook, portugal-ctt, portugal-seur, pos-indonesia, postone, post-serbia, post-slovenia, post56, postnl, postnl-international, postnl-3s, danmark-post, postnord, sweden-posten, postplus, postaplus, poste-italiane, poste-italiane-paccocelere, posten-norge, posti, posti-api, posta-romana, pressiode, procarrier, promeddelivery, productcaregroup-sftp, professional-couriers, ppl-api, ppl, purolator, purolator-api, purolator-international, qtrack, quantium, qintl-api, airterra, quiqup, quiqup-webhook, qwintry, qxpress, raf, ramgroup-za, ets-express, rl-carriers, rpd2man, rpm, rpxlogistics, rpxonline, rxo-api, rzyexpress, raben-group, raiderex, ransa-webhook, rcl, redjepakketje, redur-es, relaiscolis, rendr-webhook, returnmates-webhook, rhenus-group, rhenus-uk-api, rhenus-uk, rincos, air-canada-global, air-canada, rixonhk-api, roadbull, roadrunner-freight, roche-internal-sftp, rocketparcel, routific-webhook, royal-mail, royal-mail-ftp, royal-mail-webhook, royalshipments, russian-post, ruston, sailpost, sap-express, sekologistics, seko-sftp, showl, sf-express-api, sf-express, sf-express-cn, sfb2c, sfc, sfcservice, sglink, hotsin-cargo, shipa, shipter, shipxpres, shreenandancourier, shreetirupati, signia-ftp, signialogistics-sftp, skybox, smartcat, smsa-express, smsa-express-webhook, speedex, spflylogistica-webhook, spoton, sprint-pack, srekorea, srt-transport, starken, stepforwardfs, sto, stone3pl, szendex, safexpress, sagawa-api, sagawa, saia-freight, sassy-api, saudi-post, sberlogistics-ru, scotty, scudex-express, secretlab-webhook, seino, seino-api, sendeo-kargo, sending, sendit, sendle, sendy, nowlog-api, servip-webhook, servientrega, setel, shadowfax, dajin, ydex, kwt, sherpa, sherpa-webhook, ship-it-asia, shipentegra, shipgate, shipglobal-us, shipx, shipx-api, shippie, shippify, shippit, shiprocket, spx, spx-th, shopfans, shreeanjanicourier, shree-maruti, shunbang-express, shyplite, simpletire-webhook, simsglobal, singlobal-express, singapore-post, singapore-speedpost, sinotrans, siodemka, skelton-sftp, skyking, skyexpress-international, skyexpressinternational, skynet, skynetworldwide, skynetworldwide-uae, sky-postal, skynet-za, skynetworldwide-uk, sk-posta, smooth, sntglobal-api, sonictl, thenile-webhook, sapo, sefl, smtl, spanish-seur, spanish-seur-ftp, spanish-seur-api, specialisedfreight-za, spectran, spedisci, speedee, speedcouriers-gr, speedx, speedy, speedaf, spreetail-api, spring-gds, stallionexpress, star-track-courier, star-track-express, star-track, star-track-webhook, starlinks-api, statovernight, stop-start-api, streck-transport, sypost, superpackline, surat-kargo, sutton, swiship, swiship-jp, swiss-post, swiss-post-ftp, swiss-universal-express, loginext-webhook, t-cat, t-cat-api, taqbin-hk, tasco-my-webhook, tck-express, tcs-api, tcs, thedeliverygroup, tdn, tfm, tforce-finalmile, tigfreight, tipsa, tnt, tnt-au, tntbrasil-web, tnt-fr, tnt-fr-reference, tnt-it, tnt-reference, tnt-uk, tnt-uk-reference, tnt-click, tarrive, thaiparcels, trumpcard, tvsscs-webhook, typ, global-express, taiwan-post, tamergroup-webhook, tazmanian-freight, teamexpressllc, toll-priority, team-global-express-webhook, teleport-webhook, sic-teliway, testing-courier, thabit-logistics, thailand-post, thecourierguy, customco-api, pallet-network, thijs-nl, thunderexpress, tiki, tipsa-api, tipsa-ref, toll-ipec, toll-nz, tolos, tomydoor, tonami-ftp, esdex, topyou, tophatterexpress, toshi-webhook, total-express-api, total-express, tourline-reference, trackon, trans-kargo, trans2u, transmission-nl, transvirtual, transpak, tanet, trunkrs-webhook, trunkrs, trusk, tuffnells, tuffnells-reference, tusklogistics, u-envios, ubi-logistics, ucs, uk-mail, ucfs-api, usf-reddaway, uber-webhook, ukrposhta, uds, urb-it, courex, urbify, urgent-cargus, virtransport, viwo, vox, value-webhook, veho-webhook, venipak, vesyl, vesyl-api, viaeurope, viaxpress, vtfe, vnpost, vnpost-api, viettelpost, virtransport-sftp, wooyoung-logistics-sftp, wspexpress, wahana, wanbexpress, weworldexpress, wedo, wepost, weship-api, weship, weaship, welivery, shipwestgate, whistl, wineshipping, wineshipping-webhook, wise-express, wiseloads, wishpost, wizmo, worldcourier, worldnet, xdp-uk, xdp-uk-reference, xgs, xl-express, xpo-logistics, xpo-fr-api, xq-express, xde-webhook, xindus, xyy, xpedigo, xpert-delivery, xpost, xpressbees, xpressen-dk, yamato-tw-api, ydh-express, yrc, yto, yyexpress, yakit, taqbin-jp, taqbin-sg-api, taqbin-sg, yanwen, yifan, elian-post, yodel-api, yodeldirect, yodel, yodel-international, youparcel, yunexpress, yunant, yundaex, yunhuipost, yurtici-kargo, yusen-sftp, yusen, zjs-express, zto-domestic, zto-express, zyou, cndexpress, zajil-express, sfplus-webhook, zeek, zeleris, ziingfinalmile, zinc, zoom-red, zoom2u-webhook, zuelligpharma-sftp, acommerce, alphafast, cpacket, chronodiali-webhook, cnwangtong, delivere, e-courier-webhook, ecoutier, eparcel-kr, epostglobal, eshipper, etotal, etower, fairsenden-api, forrun, gojek, hepsijet, i-dika, i-parcel, icumulus-webhook, icumulus, idexpress-id, imile-api, ithinklogistics, liefery, mysendle-api, pack-man, shopline, solistica-api, swe, trans-o-flex-sftp, transligue-web, uparcel, uship, uc56, wndirect, xmszm, ceska-posta, winit, jd-express, jusdasr, be, padtf, pchome-api, 6ls, yingnuo-logistics, jindouyun, sdh-scm
Note: Using unsupported courier values will still work but verification may be delayed or require manual processing.
Filter shipments by specific merchant invoice ID.
Filter shipments by fulfillment method.
Filter shipments by verification status.
Pagination cursor for fetching results after a specific shipment ID.
Pagination cursor for fetching results before a specific shipment ID.
Search term to filter shipments across multiple fields.
Specific field to search within.
Sort records by the specified fields.
The sort order for each sort field is ascending unless it is prefixed with a minus, in which case it is descending.
Multiple sort fields supported by allowing comma-separated sort fields. Sort fields will be applied in the order specified.
Sorting is allowed by the following fields: id, created_at.
Example: sort=id,-created_at
curl -i -X GET \
-u <username>:<password> \
'https://api-docs.resolvepay.com/_mock/swagger/shipments?merchant_invoice_id=inv_1234567890abcdef&fulfillment_method=shipping_provider&verification_status=verified&shipment_courier=ups&limit=25&starting_after=ship_1234567890abcdef&ending_before=ship_9876543210fedcba&search=1Z123E45678901234&searchBy=tracking_number&sort=string'{ "limit": 10, "page": 1, "count": 25, "results": [ { … } ] }
Request body for creating a new shipment.
ID of the merchant invoice this shipment belongs to.
Method of fulfillment for the shipment. Determines what additional fields are required:
shipping_provider: Requires shipment_tracking_number and shipment_courier. File is not allowed.self_delivery, customer_pickup, services_only: Require a file. Tracking number and courier are optional.Tracking number (required when fulfillment_method is shipping_provider, optional otherwise).
Shipping courier (required when fulfillment_method is shipping_provider, optional otherwise). While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
curl -i -X POST \
-u <username>:<password> \
https://api-docs.resolvepay.com/_mock/swagger/shipments \
-H 'Content-Type: application/json' \
-d '{
"merchant_invoice_id": "inv_1234567890abcdef",
"fulfillment_method": "shipping_provider",
"shipment_tracking_number": "1Z123E45678901234",
"shipment_courier": "ups",
"file": {
"url": "https://bucket.s3.amazonaws.com/1234567890-document.pdf",
"size": 204800,
"metadata": {
"original_filename": "proof_of_delivery.pdf"
}
}
}'An object representing the Shipment.
Method of fulfillment for the shipment.
Tracking number provided by the shipping courier.
Shipping courier or provider name. While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
Manual or automatic verification status of the shipment.
Date time when the shipment was last updated.
Current tracking status of the shipment from the courier.
Detailed tracking substatus providing additional context about the shipment's current state.
{ "id": "ship_1234567890abcdef", "merchant_invoice_id": "inv_1234567890abcdef", "fulfillment_method": "shipping_provider", "shipment_tracking_number": "1Z123E45678901234", "shipment_courier": "ups", "verification_status": "verified", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T14:45:00Z", "tracking_status": "delivered", "tracking_substatus": "delivered_001", "expected_delivery": "2024-01-20T18:00:00Z" }
curl -i -X GET \
-u <username>:<password> \
https://api-docs.resolvepay.com/_mock/swagger/shipments/ship_1234567890abcdefAn object representing the Shipment.
Method of fulfillment for the shipment.
Tracking number provided by the shipping courier.
Shipping courier or provider name. While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
Manual or automatic verification status of the shipment.
Date time when the shipment was last updated.
Current tracking status of the shipment from the courier.
Detailed tracking substatus providing additional context about the shipment's current state.
{ "id": "ship_1234567890abcdef", "merchant_invoice_id": "inv_1234567890abcdef", "fulfillment_method": "shipping_provider", "shipment_tracking_number": "1Z123E45678901234", "shipment_courier": "ups", "verification_status": "verified", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T14:45:00Z", "tracking_status": "delivered", "tracking_substatus": "delivered_001", "expected_delivery": "2024-01-20T18:00:00Z" }
Request body for updating an existing shipment.
ID of the merchant invoice (must belong to the authenticated merchant).
Shipping courier or provider name. While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
curl -i -X PUT \
-u <username>:<password> \
https://api-docs.resolvepay.com/_mock/swagger/shipments/ship_1234567890abcdef \
-H 'Content-Type: application/json' \
-d '{
"merchant_invoice_id": "inv_9876543210fedcba",
"shipment_tracking_number": "1Z987F65432109876",
"shipment_courier": "fedex",
"file": {
"url": "https://bucket.s3.amazonaws.com/1234567890-document.pdf",
"size": 204800,
"metadata": {
"original_filename": "proof_of_delivery.pdf"
}
}
}'An object representing the Shipment.
Method of fulfillment for the shipment.
Tracking number provided by the shipping courier.
Shipping courier or provider name. While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
Manual or automatic verification status of the shipment.
Date time when the shipment was last updated.
Current tracking status of the shipment from the courier.
Detailed tracking substatus providing additional context about the shipment's current state.
{ "id": "ship_1234567890abcdef", "merchant_invoice_id": "inv_1234567890abcdef", "fulfillment_method": "shipping_provider", "shipment_tracking_number": "1Z123E45678901234", "shipment_courier": "ups", "verification_status": "verified", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T14:45:00Z", "tracking_status": "delivered", "tracking_substatus": "delivered_001", "expected_delivery": "2024-01-20T18:00:00Z" }
curl -i -X DELETE \
-u <username>:<password> \
https://api-docs.resolvepay.com/_mock/swagger/shipments/ship_1234567890abcdefAn object representing the Shipment.
Method of fulfillment for the shipment.
Tracking number provided by the shipping courier.
Shipping courier or provider name. While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
Manual or automatic verification status of the shipment.
Date time when the shipment was last updated.
Current tracking status of the shipment from the courier.
Detailed tracking substatus providing additional context about the shipment's current state.
{ "id": "ship_1234567890abcdef", "merchant_invoice_id": "inv_1234567890abcdef", "fulfillment_method": "shipping_provider", "shipment_tracking_number": "1Z123E45678901234", "shipment_courier": "ups", "verification_status": "verified", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T14:45:00Z", "tracking_status": "delivered", "tracking_substatus": "delivered_001", "expected_delivery": "2024-01-20T18:00:00Z" }
Synchronizes shipment tracking information by fetching real-time data from the courier using the existing tracking number. This endpoint retrieves the latest tracking updates directly from the shipping provider and performs instant verification of the shipment status, ensuring that the shipment data is current and accurate.
curl -i -X POST \
-u <username>:<password> \
https://api-docs.resolvepay.com/_mock/swagger/shipments/ship_1234567890abcdef/syncAn object representing the Shipment.
Method of fulfillment for the shipment.
Tracking number provided by the shipping courier.
Shipping courier or provider name. While any value can be accepted, instant verification is supported for specific couriers.
See the Shipments API documentation for the complete list of supported couriers.
Manual or automatic verification status of the shipment.
Date time when the shipment was last updated.
Current tracking status of the shipment from the courier.
Detailed tracking substatus providing additional context about the shipment's current state.
{ "id": "ship_1234567890abcdef", "merchant_invoice_id": "inv_1234567890abcdef", "fulfillment_method": "shipping_provider", "shipment_tracking_number": "1Z123E45678901234", "shipment_courier": "ups", "verification_status": "verified", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T14:45:00Z", "tracking_status": "delivered", "tracking_substatus": "delivered_001", "expected_delivery": "2024-01-20T18:00:00Z" }