{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/reference/adjustments","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/reference/adjustments","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/reference/adjustments","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Adjustment Reports","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"adjustment-reports","__idx":0},"children":["Adjustment Reports"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When creating a shipment you are required to provide the total weight of your packages. Rates are provided to you based on the weight you enter. If the weight you provide and the actual weight are different, then carriers update the rate amount and credit or debit your account with the new rate charge."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.usps.com/business/verify-postage.htm"},"children":["USPS APV Program"]}," and ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://stamps.custhelp.com/app/answers/detail/a_id/5189/~/introducing-global-advantage-program"},"children":["GP/GAP"]}," (Global Post/Global Advantage Program) allows us to provide you with itemized insight into which shipping items caused the charges or refunds to your account balance."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["New reports are generated on a nightly basis."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"report-endpoints","__idx":1},"children":["Report Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can access your cost adjustment reports via the following endpoints:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/incubator/adjustments/reports/"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/incubator/adjustments/reports/{report_id}"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-available-reports","__idx":2},"children":["List Available Reports"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list of available reports can be filtered with the following query parameters:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Query Parameter"},"children":["Query Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at_start"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["date string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only return reports that were created on or after a specific date/time",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601"},"children":["ISO 8601 Standard"]},")",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ex: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2019-07-25T15:24:46.657Z"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at_end"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["date string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only return reports that were created on or before a specific date/time ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601"},"children":["ISO 8601 Standard"]},")",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ex: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2019-07-25T15:24:46.657Z"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["integer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return a specific \"page\" of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page will be returned.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"  ex. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page_size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["integer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The number of labels to return per response. Defaults to 25. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"  ex. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort_dir"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["enumerated string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controls the sort order of the query. Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["desc"]},". ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["asc"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["desc"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort_by"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["enumerated string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controls which property the query is sorted by.  ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modified_at"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example","__idx":3},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/incubator/adjustments/reports HTTP/1.1\nHost: app.shipengine.com\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"reports\": [\n    {\n      \"report_id\": \"rpt_7QwpuXmAqPRRSfbX8QbAZ1\",\n      \"created_at\": \"2019-09-03T16:04:18.052402-04:00\",\n      \"report_download\": {\n        \"href\": \"https://api.shipengine.com/v1/incubator/adjustments/reports/rpt_7QwpuXmAqPRRSfbX8QbAZ1\"\n      }\n    },\n    {\n      \"report_id\": \"rpt_Xqg2eaygL7i5XzWJuuGENc\",\n      \"created_at\": \"2019-10-07T15:15:21.758769-04:00\",\n      \"report_download\": {\n        \"href\": \"https://api.shipengine.com/v1/incubator/adjustments/reports/rpt_Xqg2eaygL7i5XzWJuuGENc\"\n      }\n    }\n  ],\n  \"total\": 2,\n  \"page\": 1,\n  \"pages\": 1,\n  \"links\": {\n    \"first\": {\n      \"href\": \"https://api.shipengine.com/v1/incubator/adjustments/reports?page=1&page_size=50&sort_dir=asc&sort_by=created_at\"\n    },\n    \"last\": {\n      \"href\": \"https://api.shipengine.com/v1/incubator/adjustments/reports?page=1&page_size=50&sort_dir=asc&sort_by=created_at\"\n    },\n    \"prev\": {\n      \"href\": \"https://api.shipengine.com/v1/incubator/adjustments/reports?page=1&page_size=50&sort_dir=asc&sort_by=created_at\"\n    },\n    \"next\": {\n      \"href\": \"https://api.shipengine.com/v1/incubator/adjustments/reports?page=1&page_size=50&sort_dir=asc&sort_by=created_at\"\n    }\n  }\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-individual-reports","__idx":4},"children":["Retrieve Individual Reports"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/incubator/adjustments/reports/{report_id} HTTP/1.1\nHost: app.shipengine.com\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"csv","header":{"controls":{"copy":{}}},"source":"CarrierID,ShipmentID,AdjustmentType,AdjustmentID,TransactionID,ExternalShipmentID,TrackingNumber,ReasonCode,AdjustmentAmount,AdjustmentDate,DisputeStatus,DisputeCreatedAt,DisputeUpdatedAt,ActualTrackingNumber,ActualService,ActualPackage,ActualWeight,ActualLength,ActualWidth,ActualHeight,ActualOriginZip,ActualToZip,ActualCountry,ActualZone,ActualInternationalZone\nse-194932,se-220074122,GAP,,bd9f1e7d-2d4f-42e1-b0b6-efcbd1b6db26,403-9718334-5502758,LX678053798US,,0.710,2019-06-19 07:46:23.93,,,,LX678053798US,International First Class,Postcard,0.274,0.00,0.00,0.00,,08008,ES,,\nse-194932,se-220084778,GAP,,572781bd-f52c-46bf-8345-a8917ec8193f,407-9977098-3301963,LX678054802US,,1.070,2019-06-19 07:46:23.867,,,,LX678054802US,International First Class,Postcard,0.338,0.00,0.00,0.00,,20149,IT,,\nse-194932,se-220085586,GAP,,5c8fdc91-1baf-41a0-adc7-bcbad0b7a221,407-1165026-0025912,LX678054855US,,1.070,2019-06-19 07:46:23.747,,,,LX678054855US,International First Class,Postcard,0.350,0.00,0.00,0.00,,34170,IT,,\nse-194932,se-220106892,GAP,,d22e13ce-d5c5-4b6e-960e-f36a153ae699,405-9825900-9360313,LX678056729US,,0.340,2019-06-19 07:46:23.51,,,,LX678056729US,International First Class,Postcard,0.248,0.00,0.00,0.00,,89128,IT,,\nse-194932,se-220106249,GAP,,293cf295-3ac7-46dd-8ce8-3c70bbce62e7,406-4443199-4692349,LX678056692US,,0.710,2019-06-19 07:46:23.263,,,,LX678056692US,International First Class,Postcard,0.280,0.00,0.00,0.00,,49124,FR,,\nse-194932,se-220106133,GAP,,46627b13-d7a8-4040-adbb-96c9aceba6b5,402-6135486-2025927,LX678056675US,,0.340,2019-06-19 07:46:22.993,,,,LX678056675US,International First Class,Postcard,0.232,0.00,0.00,0.00,,24126,IT,,\nse-194932,se-220105026,GAP,,c7cc0d76-91ca-4f3a-aa92-29be1cf1ccb8,206-5718974-6791531,LX678056542US,,0.720,2019-06-19 07:46:22.93,,,,LX678056542US,International First Class,Postcard,0.150,0.00,0.00,0.00,,ME14 2AU,GB,,\nse-194932,se-220103277,GAP,,4290de02-b97b-4ff4-b0ca-aab2087ede21,026-1881690-4479549,LX678056445US,,0.340,2019-06-19 07:46:22.87,,,,LX678056445US,International First Class,Postcard,0.210,0.00,0.00,0.00,,HA4 6SY,GB,,\nse-194932,se-220100680,GAP,,2cc3df36-8679-4a6a-86d8-84a4d097196d,306-4120817-1421140,LX678056247US,,0.340,2019-06-19 07:46:22.82,,,,LX678056247US,International First Class,Postcard,0.250,0.00,0.00,0.00,,13585,DE,,\nse-194932,se-220100132,GAP,,7e1f4c73-faf2-414d-9d61-fcdb81e73a93,406-5878652-3642766,LX678056105US,,0.710,2019-06-19 07:46:22.777,,,,LX678056105US,International First Class,Postcard,0.290,0.00,0.00,0.00,,06950,FR,,\nse-194932,se-220099901,GAP,,ad9c0fce-7e09-4031-adc5-ba8bb9fd4b6f,305-7237094-2605131,LX678056088US,,1.510,2019-06-19 07:46:22.727,,,,LX678056088US,International First Class,Postcard,0.520,0.00,0.00,0.00,,69214,DE,,\nse-194932,se-220099562,GAP,,c0d70fe2-5065-40a4-85b4-2e70efa73986,302-5169649-0737965,LX678056065US,,1.780,2019-06-19 07:46:22.677,,,,LX678056065US,International First Class,Postcard,0.440,0.00,0.00,0.00,,88471,DE,,\nse-194932,se-220099379,GAP,,6a573356-2b90-4b9a-adc2-ae2b0c4db321,028-1527563-2081155,LX678056057US,,1.070,2019-06-19 07:46:22.6,,,,LX678056057US,International First Class,Postcard,0.360,0.00,0.00,0.00,,49828,DE,,\nse-194932,se-220098506,GAP,,0717c2fd-1ddf-4810-bde6-ae03d4af538f,402-7129924-5017903,LX678055975US,,1.780,2019-06-19 07:46:22.533,,,,LX678055975US,International First Class,Postcard,0.470,0.00,0.00,0.00,,81030,IT,,\nse-194932,se-220098108,GAP,,b171cf49-2c21-42eb-86bf-04ea06a09c27,026-6433086-9347511,LX678055958US,,0.710,2019-06-19 07:46:22.483,,,,LX678055958US,International First Class,Postcard,0.280,0.00,0.00,0.00,,DE22 4EA,GB,,\nse-194932,se-220097943,GAP,,d82ac983-a5a4-45e9-9e57-b81e3db6e731,405-6321965-5582767,LX678055944US,,0.340,2019-06-19 07:46:22.44,,,,LX678055944US,International First Class,Postcard,0.250,0.00,0.00,0.00,,10600,ES,,\nse-194932,se-220097698,GAP,,a8730382-5120-4049-887c-34a38a2f59a5,303-4759563-2469915,LX678055935US,,0.340,2019-06-19 07:46:22.397,,,,LX678055935US,International First Class,Postcard,0.220,0.00,0.00,0.00,,89356,DE,,\nse-194932,se-220097605,GAP,,eed000f2-f745-4738-ab36-6996f68f1749,302-3101481-3293908,LX678055913US,,0.340,2019-06-19 07:46:22.343,,,,LX678055913US,International First Class,Postcard,0.230,0.00,0.00,0.00,,76698,DE,,\nse-194932,se-220097223,GAP,,ac8b14ab-b53d-4c2f-9701-ced7d4001d00,405-6184473-9254741,LX678055895US,,5.010,2019-06-19 07:46:22.17,,,,LX678055895US,International First Class,Postcard,1.080,0.00,0.00,0.00,,46220,ES,,\nse-194932,se-220096444,GAP,,acec3e2f-e4eb-470e-9cae-ade0c4ffb2c7,026-6804533-6165122,LX678055785US,,1.510,2019-06-19 07:46:22.1,,,,LX678055785US,International First Class,Postcard,0.550,0.00,0.00,0.00,,CH3 8NA,GB,,\nse-194932,se-220096205,GAP,,5f7a128c-92ee-44d4-b19b-c4cbbbc795f8,303-2296607-4377132,LX678055745US,,11.690,2019-06-19 07:46:22.017,,,,LX678055745US,International First Class,Postcard,1.798,0.00,0.00,0.00,,59192,DE,,\nse-194932,se-220095711,GAP,,b086404a-b120-4056-8092-ffc1bbe3ba4c,406-7291054-6723562,LX678055737US,,0.340,2019-06-19 07:46:21.93,,,,LX678055737US,International First Class,Postcard,0.240,0.00,0.00,0.00,,31290,FR,,\nse-194932,se-220095377,GAP,,e282e1ca-7c1f-4022-87d1-e3ae3d34bd97,026-1304524-8936364,LX678055697US,,2.990,2019-06-19 07:46:21.887,,,,LX678055697US,International First Class,Postcard,0.916,0.00,0.00,0.00,,LS8 1DH,GB,,\nse-194932,se-220093479,GAP,,6940c751-b8dc-4479-86f6-6b015e5c5dab,171-2909966-3349165,LX678055621US,,4.770,2019-06-19 07:46:21.643,,,,LX678055621US,International First Class,Postcard,0.848,0.00,0.00,0.00,,04100,FR,,\nse-194932,se-220091942,GAP,,e8dabf37-7de1-4a19-b0f7-dcc30ed0d1bc,305-3877982-1914764,LX678055459US,,1.070,2019-06-19 07:46:21.557,,,,LX678055459US,International First Class,Postcard,0.328,0.00,0.00,0.00,,81543,DE,,\n","lang":"csv"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reports-webhook-event","__idx":5},"children":["Reports Webhook Event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reports can also be retrieved with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report_complete"]}," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/guides/webhooks"},"children":["webhook event"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-webhook-for-reports","__idx":6},"children":["Create Webhook for Reports"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/environment/webhooks HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nSELLER-ID: __YOUR_SELLER_ID_HERE__\nContent-Type: application/json\n\n{\n  \"url\": \"__YOUR_URL_ENDPOINT_HERE__\",\n  \"event\": \"report_complete\"\n}\n\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhook Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"resource_url\": \"https://api.shipengine.com/v1/incubator/adjustments/reports/rpt_gGhc2RmYBzGZh\",\n  \"resource_type\": \"API_REPORT_COMPLETE\",\n  \"data\": {\n    \"report_type\": \"usps_apv\",\n    \"created_at\": \"2019-06-30T15:35:47.173Z\",\n    \"report_url\": {\n      \"href\": \"https://api.shipengine.com/v1/incubator/adjustments/reports/rpt_gGhc2RmYBzGZh\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Adjustment Reports","id":"adjustment-reports","depth":1},{"value":"Report Endpoints","id":"report-endpoints","depth":2},{"value":"List Available Reports","id":"list-available-reports","depth":2},{"value":"Example","id":"example","depth":2},{"value":"Retrieve Individual Reports","id":"retrieve-individual-reports","depth":2},{"value":"Reports Webhook Event","id":"reports-webhook-event","depth":2},{"value":"Create Webhook for Reports","id":"create-webhook-for-reports","depth":3}],"frontmatter":{"seo":{"title":"Adjustment Reports"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/reference/adjustments","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}