The authorization header should contain the token provided to you by Phobio and use the Token scheme. The header will resemble the following:
Authorization: Token am9obi5kb2U6OTQ4MzQzdWppZHNvZmg4OXAxO\n\nInclude this header with all requests to the Phobio API.
\nThe Phobio API supports the JSON content type only. The content type should always be set using HTTP headers in the following way:
\nAccept: application/json\nContent-Type: application/json\n\nMost GET resources that return a list of objects are paginated. Pagination in the Phobio API follows a predictable pattern, and has a maximum limit of 50 items per page. The following is an example of pagination in the Phobio API:
\n{\n \"count\": 3,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\n\nIn paginated requests, the following parameters are available:
\nPhobio's API uses standard HTTP error codes, and supplements them with additional detail when required, such as during input validation.
\nAdditional detail will be represented as detail:
{\n \"detail\": \"Not found.\"\n}\n\nOr as the field's name, in the case of a validation-related error:
\n{\n \"products\": [\n {\n \"uid\": [\n \"Product with UID 123 could not be found\"\n ]\n }\n ]\n}\n\nThe API token provided to you by Phobio.
\n","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept-Language","value":"en","type":"text"}],"url":"https://phobio.com/services-api/v1/box_fulfillment/","description":"List all pending shipments.
\n","urlObject":{"path":["box_fulfillment",""],"host":["https://phobio.com/services-api/v1"],"query":[{"disabled":true,"key":"page","value":""}],"variable":[]}},"response":[{"id":"623e6dc5-5a43-46f6-bd73-5f9dd6f1c6e3","name":"List Box Fulfillment","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token abcd1234","description":"The API token provided to you by Phobio.","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept-Language","value":"en","type":"text"}],"url":"https://phobio.com/services-api/v1/box_fulfillment/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"43281"},{"key":"Content-Language","value":"en"},{"key":"Vary","value":"Accept-Language, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uid\": \"40643888775\",\n \"company_name\": \"Brands R Us, Inc.\",\n \"company_uid\": \"80145339075\",\n \"channel\": \"d2c\",\n \"box_sku\": \"C_PHO\",\n \"reference_1\": \"20123456789\",\n \"reference_2\": \"30987654321\",\n \"shipping_service_type_outbound\": \"fedex_ground\",\n \"shipping_service_type_inbound\": \"fedex_ground\",\n \"shipping_account_number_outbound\": \"776655443\",\n \"shipping_account_number_inbound\": \"334455667\",\n \"customer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"address_1\": \"1040 Anytown Pl.\",\n \"address_2\": null,\n \"city\": \"Nowhere\",\n \"state\": \"VA\",\n \"country_code\": \"US\",\n \"postal_code\": \"10910\"\n },\n \"facility\": {\n \"first_name\": \"Phobio\",\n \"last_name\": \"Receiving Manager\",\n \"address_1\": \"3100 Cumberland Blvd SE\",\n \"address_2\": \"STE 200\",\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"country_code\": \"US\",\n \"postal_code\": \"30339\"\n }\n },\n {\n \"uid\": \"40643888776\",\n \"company\": \"Brands R Us, Inc.\",\n \"channel\": \"d2c\",\n \"box_sku\": \"C_PHO\",\n \"reference_1\": \"20123456789\",\n \"reference_2\": \"30987654321\",\n \"shipping_service_type_outbound\": \"fedex_ground\",\n \"shipping_service_type_inbound\": \"fedex_ground\",\n \"shipping_account_number_outbound\": \"776655443\",\n \"shipping_account_number_inbound\": \"334455667\",\n \"customer\": {\n \"first_name\": \"Alice\",\n \"last_name\": \"Anderson\",\n \"address_1\": \"300 Anytown Rd.\",\n \"address_2\": null,\n \"city\": \"Nowhere\",\n \"state\": \"VA\",\n \"country_code\": \"US\",\n \"postal_code\": \"10910\"\n },\n \"facility\": {\n \"first_name\": \"Phobio\",\n \"last_name\": \"Receiving Manager\",\n \"address_1\": \"3100 Cumberland Blvd SE\",\n \"address_2\": \"STE 200\",\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"country_code\": \"US\",\n \"postal_code\": \"30339\"\n }\n },\n ]\n}"}],"_postman_id":"ed134037-5f76-4fe8-aeb1-17bcf0aa1815"},{"name":"Update Shipment Tracking","id":"23f38fac-413e-42b6-b5be-f74d9be48bfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"The API token provided to you by Phobio.
\n","key":"Authorization","type":"text","value":"Token abcd1234"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept-Language","type":"text","value":"en"}],"body":{"mode":"raw","raw":"[\n {\n \"uid\": \"40472087754\",\n \"inbound_tracking\": \"27399882832\",\n \"inbound_carrier\": \"fedex\",\n \"outbound_tracking\": \"188202387432\",\n \"outbound_carrier\": \"fedex\"\n },\n {\n \"uid\": \"40430445854\",\n \"inbound_tracking\": \"28300992432\",\n \"inbound_carrier\": \"fedex\",\n \"outbound_tracking\": \"199302387453\",\n \"outbound_carrier\": \"fedex\"\n },\n {\n \t\"uid\": \"40495738502\",\n \t\"fulfillment_rejection_code\": \"FRC1\"\n }\n]"},"url":"https://phobio.com/services-api/v1/box_fulfillment/","description":"Update the tracking numbers and carriers on inbound and outbound shipments. The endpoint accepts an array of objects. Up to 25 objects can be submitted at once. Any item that cannot be updated will be returned in the response. Each object has the following parameters:
\n*Valid options for carrier include: ups_ground, fedex_ground, fedex_ground_ca, canadapost_regular_parcel.
Fulfillment Rejection Codes (FRC) can be posted as well in the same request, but must be a separate object.
\nThe API token provided to you by Phobio.
\n","key":"Authorization","type":"text","value":"Token abcd1234"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept-Language","type":"text","value":"en"}],"body":{"mode":"raw","raw":""},"url":"https://phobio.com/services-api/v1/box_fulfillment/:uid","description":"A PUT to the box fulfillment endpoint notifies Phobio that shipment data has been received. Any item that is updated with this enpoint will be considered \"in progress\", and will no longer show in the list box fullfilment endpoint.
\nThis call should be made when fulfillment has begun to reduce the size of the box listing.
\n","urlObject":{"path":["box_fulfillment",":uid"],"host":["https://phobio.com/services-api/v1"],"query":[],"variable":[{"description":{"content":"Shipment UID
\n","type":"text/plain"},"type":"string","value":"","key":"uid"}]}},"response":[{"id":"0e2302d2-d9b9-4aed-a095-0a8dfd76852d","name":"Box Fulfillment In Progress","originalRequest":{"method":"PUT","header":[{"description":"The API token provided to you by Phobio.","key":"Authorization","type":"text","value":"Token abcd1234"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept-Language","type":"text","value":"en"}],"body":{"mode":"raw","raw":""},"url":"https://phobio.com/services-api/v1/box_fulfillment/40472087754"},"status":"NO CONTENT","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"60760bbb-9f3c-45ab-9b64-30d779646052"}],"id":"394a690e-8587-4646-8762-3e6e995b88f3","description":"The Box Fulfillment API provides information on pending shipments, and allows a shipping partner to update Phobio with tracking information as pending shipments are kitted and fulfilled.
\n","event":[{"listen":"prerequest","script":{"id":"a3586148-888d-4e3f-8cc9-91a99c578873","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7074c61-0b56-46f9-b0ee-a178d5bd24c0","type":"text/javascript","exec":[""]}}],"_postman_id":"394a690e-8587-4646-8762-3e6e995b88f3"},{"name":"Orders","item":[{"name":"Update Order","id":"efe9eb2a-96fd-4c88-a961-1b110e6584e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"description":"The API token provided to you by Phobio.
\n","key":"Authorization","type":"text","value":"Token abcd1234"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept-Language","type":"text","value":"en"}],"body":{"mode":"raw","raw":"{\n \"buyer_uid\": \"58886238045\",\n \"total_in_cents\": 433000000,\n \"tax_in_cents\": 1382000,\n \"paid\": \"2023-08-29T07:00:00\"\n}"},"url":"https://phobio.com/services-api/v1/orders/:uid/","description":"Update the Buyer and sell total of an Order.
\nOrder UID
\n","type":"text/plain"},"type":"any","value":"","key":"uid"}]}},"response":[{"id":"15d376fd-5dee-464e-b5de-81ea8b82f091","name":"Update Order","originalRequest":{"method":"PUT","header":[{"description":"The API token provided to you by Phobio.","key":"Authorization","type":"text","value":"Token abcd1234"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept-Language","type":"text","value":"en"}],"body":{"mode":"raw","raw":"{\n \"buyer_uid\": \"58886238045\",\n \"total_in_cents\": 433000000,\n \"tax_in_cents\": 1382000,\n \"paid\": \"2023-08-29T07:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://phobio.com/services-api/v1/orders/:uid/","host":["https://phobio.com/services-api/v1"],"path":["orders",":uid",""],"variable":[{"key":"uid","value":"59747185862","description":"Order UID"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"efe9eb2a-96fd-4c88-a961-1b110e6584e7"}],"id":"e27593ae-1708-43f4-9181-826ee3c2d6e8","description":"The Orders API provides information on orders, and allows for the update of certain attributes of orders.
\n","_postman_id":"e27593ae-1708-43f4-9181-826ee3c2d6e8"}],"event":[{"listen":"prerequest","script":{"id":"d7e0b292-fa33-4a1a-b66e-9150f9711f53","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"da7b1fb1-d31b-4d60-bccd-a11994183c15","type":"text/javascript","exec":[""]}}],"variable":[{"key":"TOKEN","value":"abcd1234"},{"key":"BASE_URL","value":"https://phobio.com/services-api/v1"}]}