{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-connect-apis-catalog/product-catalog/Prospects/sidebars.yaml","current-catalog-info":"current-catalog-info-/connect-apis-catalog/product-catalog/prospects/prospects"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Complete Prospects Order Workflow","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"complete-prospects-order-workflow","__idx":0},"children":["Complete Prospects Order Workflow"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This workflow demonstrates the full Prospects API integration journey for discovering and pre-qualifying look-alike businesses using Creditsafe data:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authenticate"]}," - Obtain JWT token for API access"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Preview Order"]}," - Estimate the number of matching companies before creating an order"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create Order"]}," - Submit a prospect order based on search criteria"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get Order Details"]}," - Retrieve the order status and results summary"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Export Order"]}," - Download the order results in your preferred format (xls, xlsx, or csv)"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"workflow-diagram","__idx":2},"children":["Workflow Diagram"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD;\n A([Step 1: Authenticate]) --> B([Step 2: Preview Order])\n B --> C([Step 3: Create Order])\n C --> D([Step 4: Get Order Details])\n D --> E{Order Complete?}\n E -- Yes --> F([Step 5: Export Order])\n E -- No --> D\n F --> G{Export Ready?}\n G -- Yes 200 --> H[Download File]\n G -- No 202 --> F\n","diagramHtml":"

Yes

No

Yes 200

No 202

Step 1: Authenticate

Step 2: Preview Order

Step 3: Create Order

Step 4: Get Order Details

Order Complete?

Step 5: Export Order

Export Ready?

Download File

","diagramHtmlDark":"

Yes

No

Yes 200

No 202

Step 1: Authenticate

Step 2: Preview Order

Step 3: Create Order

Step 4: Get Order Details

Order Complete?

Step 5: Export Order

Export Ready?

Download File

"},"children":["flowchart TD;\n A([Step 1: Authenticate]) --> B([Step 2: Preview Order])\n B --> C([Step 3: Create Order])\n C --> D([Step 4: Get Order Details])\n D --> E{Order Complete?}\n E -- Yes --> F([Step 5: Export Order])\n E -- No --> D\n F --> G{Export Ready?}\n G -- Yes 200 --> H[Download File]\n G -- No 202 --> F\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Diagram summary: This workflow shows the complete Prospects order lifecycle. After authentication, the user previews an order to estimate matches, creates the order, polls for order completion, and exports the results. The export step may return 202 Accepted if still processing, requiring a retry."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sequence-diagram","__idx":3},"children":["Sequence Diagram"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant Client\n participant API as Prospects API\n participant Backend as Creditsafe Backend\n \n Client->>API: POST /authenticate\n Note right of Client: Step 1: Authenticate\n API-->>Client: 200 OK {token}\n \n Client->>API: POST /prospects/orders/preview\n Note right of Client: Step 2: Preview Order\n activate API\n API->>Backend: Validate criteria & estimate matches\n Backend-->>API: Match count by country\n alt Success\n API-->>Client: 200 OK {totalCount, breakdown}\n else Validation Error (400)\n API-->>Client: 400 Bad Request {correlationId, message, details}\n else Auth Error (401)\n API-->>Client: 401 Unauthorized\n else Credit Error (403)\n API-->>Client: 403 Forbidden\n end\n deactivate API\n \n Client->>API: POST /prospects/orders\n Note right of Client: Step 3: Create Order\n activate API\n API->>Backend: Create order & process\n Backend-->>API: Order created {orderId}\n alt Success\n API-->>Client: 200 OK {orderId}\n else Validation Error (400)\n API-->>Client: 400 Bad Request\n else Auth Error (401)\n API-->>Client: 401 Unauthorized\n else Credit Error (403)\n API-->>Client: 403 Forbidden\n end\n deactivate API\n \n Client->>API: GET /prospects/orders/{id}\n Note right of Client: Step 4: Get Order Details\n alt Success\n API-->>Client: 200 OK {status, results}\n else Not Found (404)\n API-->>Client: 404 Not Found\n end\n \n Client->>API: GET /prospects/orders/{id}/export\n Note right of Client: Step 5: Export Order\n alt Export Ready\n API-->>Client: 200 OK {binary file}\n else Export Processing\n API-->>Client: 202 Accepted\n else Not Found (404)\n API-->>Client: 404 Not Found\n end\n","diagramHtml":"Creditsafe BackendProspects APIClientCreditsafe BackendProspects APIClientStep 1: AuthenticateStep 2: Preview Orderalt[Success][Validation Error (400)][Auth Error (401)][Credit Error (403)]Step 3: Create Orderalt[Success][Validation Error (400)][Auth Error (401)][Credit Error (403)]Step 4: Get Order Detailsalt[Success][Not Found (404)]Step 5: Export Orderalt[Export Ready][Export Processing][Not Found (404)]POST /authenticate200 OK {token}POST /prospects/orders/previewValidate criteria & estimate matchesMatch count by country200 OK {totalCount, breakdown}400 Bad Request {correlationId, message, details}401 Unauthorized403 ForbiddenPOST /prospects/ordersCreate order & processOrder created {orderId}200 OK {orderId}400 Bad Request401 Unauthorized403 ForbiddenGET /prospects/orders/{id}200 OK {status, results}404 Not FoundGET /prospects/orders/{id}/export200 OK {binary file}202 Accepted404 Not Found","diagramHtmlDark":"Creditsafe BackendProspects APIClientCreditsafe BackendProspects APIClientStep 1: AuthenticateStep 2: Preview Orderalt[Success][Validation Error (400)][Auth Error (401)][Credit Error (403)]Step 3: Create Orderalt[Success][Validation Error (400)][Auth Error (401)][Credit Error (403)]Step 4: Get Order Detailsalt[Success][Not Found (404)]Step 5: Export Orderalt[Export Ready][Export Processing][Not Found (404)]POST /authenticate200 OK {token}POST /prospects/orders/previewValidate criteria & estimate matchesMatch count by country200 OK {totalCount, breakdown}400 Bad Request {correlationId, message, details}401 Unauthorized403 ForbiddenPOST /prospects/ordersCreate order & processOrder created {orderId}200 OK {orderId}400 Bad Request401 Unauthorized403 ForbiddenGET /prospects/orders/{id}200 OK {status, results}404 Not FoundGET /prospects/orders/{id}/export200 OK {binary file}202 Accepted404 Not Found"},"children":["sequenceDiagram\n participant Client\n participant API as Prospects API\n participant Backend as Creditsafe Backend\n \n Client->>API: POST /authenticate\n Note right of Client: Step 1: Authenticate\n API-->>Client: 200 OK {token}\n \n Client->>API: POST /prospects/orders/preview\n Note right of Client: Step 2: Preview Order\n activate API\n API->>Backend: Validate criteria & estimate matches\n Backend-->>API: Match count by country\n alt Success\n API-->>Client: 200 OK {totalCount, breakdown}\n else Validation Error (400)\n API-->>Client: 400 Bad Request {correlationId, message, details}\n else Auth Error (401)\n API-->>Client: 401 Unauthorized\n else Credit Error (403)\n API-->>Client: 403 Forbidden\n end\n deactivate API\n \n Client->>API: POST /prospects/orders\n Note right of Client: Step 3: Create Order\n activate API\n API->>Backend: Create order & process\n Backend-->>API: Order created {orderId}\n alt Success\n API-->>Client: 200 OK {orderId}\n else Validation Error (400)\n API-->>Client: 400 Bad Request\n else Auth Error (401)\n API-->>Client: 401 Unauthorized\n else Credit Error (403)\n API-->>Client: 403 Forbidden\n end\n deactivate API\n \n Client->>API: GET /prospects/orders/{id}\n Note right of Client: Step 4: Get Order Details\n alt Success\n API-->>Client: 200 OK {status, results}\n else Not Found (404)\n API-->>Client: 404 Not Found\n end\n \n Client->>API: GET /prospects/orders/{id}/export\n Note right of Client: Step 5: Export Order\n alt Export Ready\n API-->>Client: 200 OK {binary file}\n else Export Processing\n API-->>Client: 202 Accepted\n else Not Found (404)\n API-->>Client: 404 Not Found\n end\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Diagram summary: This sequence diagram shows the interaction between the client, Prospects API, and Creditsafe backend. Step 1 authenticates and returns a token. Step 2 previews the order with validation, showing success (200), validation errors (400), authentication errors (401), and credit errors (403). Step 3 creates the order, returning an orderId. Step 4 retrieves order details, showing success (200) and not found (404) paths. Step 5 exports results, showing ready (200), processing (202), and not found (404) responses."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling","__idx":4},"children":["Error Handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints follow standard Prospects API error patterns. Errors include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["correlationId"]}," for support tracking."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-http-status-codes","__idx":5},"children":["Common HTTP Status Codes"]},{"$$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":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Typical Cause"},"children":["Typical Cause"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Action"},"children":["Action"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad Request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid search criteria, validation failure"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check request body against schema, verify enum values and required fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid/expired token"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Re-authenticate using Step 1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Forbidden"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient permissions or credits"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verify account permissions and credit balance"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order doesn't exist"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verify order ID from Step 3 output"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["202"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accepted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Export still processing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retry Step 5 after a short delay (e.g., 5-10 seconds)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal Server Error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["System issue"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retry with exponential backoff (2s, 4s, 8s)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"error-response-format","__idx":6},"children":["Error Response Format"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"correlationId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"message\": \"Validation failed\",\n \"details\": \"Invalid country code: 'XX' is not a supported country\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"retry-guidelines","__idx":7},"children":["Retry Guidelines"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["401 (Unauthorized):"]}," Re-authenticate once, then fail"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["403 (Forbidden):"]}," Do not retry (permission or credit issue)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["404 (Not Found):"]}," Do not retry in workflow (indicates data flow error)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["202 (Accepted):"]}," Retry Step 5 (export) with delays until 200 received"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["500/503 (Server Errors):"]}," Retry up to 3 times with exponential backoff"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-authenticate","__idx":8},"children":["Step 1: Authenticate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authenticate with username and password to obtain a JWT token for API access."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies To:"]}," All workflows"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint","__idx":9},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /authenticate\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters","__idx":10},"children":["Request 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":"Parameter"},"children":["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":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prospects API username for authentication"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["password"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prospects API password for authentication"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":11},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"username\": \"your-username\",\n \"password\": \"your-password\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":12},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria","__idx":13},"children":["Success Criteria"]},{"$$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":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["token"]}," field returned in response body"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-errors","__idx":14},"children":["Common Errors"]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid username or password format"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Incorrect credentials"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-preview-order","__idx":15},"children":["Step 2: Preview Order"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Preview the number of matching companies for prospect search criteria before creating an order. Returns a breakdown by country and registration type to help estimate scope and cost."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies To:"]}," Complete order workflow (optional but recommended)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-1","__idx":16},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /prospects/orders/preview\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters-1","__idx":17},"children":["Request 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":"Parameter"},"children":["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":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," (header)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer token from Step 1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request body contains search criteria (countries, industries, employee ranges, etc.)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prospect search criteria matching API schema"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-1","__idx":18},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"countries\": [\"GB\", \"US\"],\n \"industries\": [\"62\", \"70\"],\n \"employeeRange\": {\n \"min\": 10,\n \"max\": 100\n }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-1","__idx":19},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"totalCount\": 1250,\n \"breakdown\": [\n {\n \"country\": \"GB\",\n \"registrationType\": \"Limited\",\n \"count\": 850\n },\n {\n \"country\": \"US\",\n \"registrationType\": \"Corporation\",\n \"count\": 400\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria-1","__idx":20},"children":["Success Criteria"]},{"$$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":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalCount"]}," field returned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breakdown"]}," array returned with country-level counts"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-errors-1","__idx":21},"children":["Common Errors"]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid search criteria (e.g., unsupported country code, invalid enum values)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or expired authentication token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient permissions to preview orders"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-create-order","__idx":22},"children":["Step 3: Create Order"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new prospects order based on search criteria. This endpoint orders a list of companies matching specific criteria for prospecting and business development."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies To:"]}," Complete order workflow"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-2","__idx":23},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /prospects/orders\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters-2","__idx":24},"children":["Request 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":"Parameter"},"children":["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":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," (header)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer token from Step 1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request body contains search criteria"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prospect search criteria (same structure as Step 2)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-2","__idx":25},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"countries\": [\"GB\", \"US\"],\n \"industries\": [\"62\", \"70\"],\n \"employeeRange\": {\n \"min\": 10,\n \"max\": 100\n }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-2","__idx":26},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"orderId\": \"a3f2b1d5-8c4e-4f2a-9e7b-1c5d6e8f9a0b\",\n \"status\": \"Processing\",\n \"createdDate\": \"2026-07-22T10:30:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria-2","__idx":27},"children":["Success Criteria"]},{"$$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":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderId"]}," field returned (GUID format)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-errors-2","__idx":28},"children":["Common Errors"]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid search criteria or request format"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or expired authentication token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient credits or permissions to create order"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-get-order-details","__idx":29},"children":["Step 4: Get Order Details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve details of a specific prospect order by its unique identifier. Returns order status, progress information, search criteria used, and results summary when the order is completed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies To:"]}," Complete order workflow"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-3","__idx":30},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /prospects/orders/{id}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters-3","__idx":31},"children":["Request 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":"Parameter"},"children":["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":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," (header)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer token from Step 1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," (path)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order ID from Step 3 (GUID format)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-3","__idx":32},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"orderId\": \"a3f2b1d5-8c4e-4f2a-9e7b-1c5d6e8f9a0b\",\n \"status\": \"Completed\",\n \"createdDate\": \"2026-07-22T10:30:00Z\",\n \"completedDate\": \"2026-07-22T10:35:00Z\",\n \"totalResults\": 1250,\n \"searchCriteria\": {\n \"countries\": [\"GB\", \"US\"],\n \"industries\": [\"62\", \"70\"]\n }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria-3","__idx":33},"children":["Success Criteria"]},{"$$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":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderId"]}," matches requested ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," field indicates order progress"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-errors-3","__idx":34},"children":["Common Errors"]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or expired authentication token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order not found (invalid order ID or unauthorized access)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-5-export-order","__idx":35},"children":["Step 5: Export Order"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Export the results of a completed prospect order as a downloadable file. Supports xls, xlsx, and csv formats. If the export is still being processed, returns 202 Accepted and should be retried."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies To:"]}," Complete order workflow (after order is completed)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"endpoint-4","__idx":36},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /prospects/orders/{id}/export?fileFormat={format}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters-4","__idx":37},"children":["Request 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":"Parameter"},"children":["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":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," (header)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer token from Step 1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," (path)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order ID from Step 3 (GUID format)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileFormat"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," (query)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Export file format: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["xls"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["xlsx"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["csv"]}," (optional)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-200---ready","__idx":38},"children":["Example Response (200 - Ready)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Binary file stream (xls/xlsx/csv content)\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-202---processing","__idx":39},"children":["Example Response (202 - Processing)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"message\": \"Export is still being processed. Please retry in a few moments.\",\n \"estimatedCompletionTime\": \"2026-07-22T10:40:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"success-criteria-4","__idx":40},"children":["Success Criteria"]},{"$$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":"Condition"},"children":["Condition"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP Status Code = ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Binary file stream returned"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"common-errors-4","__idx":41},"children":["Common Errors"]},{"$$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":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Cause"},"children":["Cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["202"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Export still processing - retry after short delay"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid file format parameter"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or expired authentication token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order not found or export not available"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"implementation-notes","__idx":42},"children":["Implementation Notes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"polling-strategy-for-order-completion","__idx":43},"children":["Polling Strategy for Order Completion"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After creating an order (Step 3), poll Step 4 (Get Order Details) to check order status:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recommended interval:"]}," 5-10 seconds"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Maximum retries:"]}," 60 attempts (5-10 minutes total)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," field equals ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Completed\""]}," before proceeding to Step 5"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"polling-strategy-for-export-readiness","__idx":44},"children":["Polling Strategy for Export Readiness"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After requesting export (Step 5), if you receive 202 Accepted:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recommended interval:"]}," 5-10 seconds"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Maximum retries:"]}," 30 attempts (2.5-5 minutes total)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Success:"]}," HTTP 200 with binary file stream"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"file-format-selection","__idx":45},"children":["File Format Selection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Choose the export format based on your downstream systems:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CSV:"]}," Lightweight, universal compatibility, best for data import"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["XLSX:"]}," Excel format with formatting support, best for manual review"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["XLS:"]}," Legacy Excel format, use only for compatibility requirements"]}]}]},"headings":[{"value":"Complete Prospects Order Workflow","id":"complete-prospects-order-workflow","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Workflow Diagram","id":"workflow-diagram","depth":2},{"value":"Sequence Diagram","id":"sequence-diagram","depth":2},{"value":"Error Handling","id":"error-handling","depth":2},{"value":"Common HTTP Status Codes","id":"common-http-status-codes","depth":3},{"value":"Error Response Format","id":"error-response-format","depth":3},{"value":"Retry Guidelines","id":"retry-guidelines","depth":3},{"value":"Step 1: Authenticate","id":"step-1-authenticate","depth":2},{"value":"Endpoint","id":"endpoint","depth":3},{"value":"Request Parameters","id":"request-parameters","depth":3},{"value":"Example Request","id":"example-request","depth":3},{"value":"Example Response","id":"example-response","depth":3},{"value":"Success Criteria","id":"success-criteria","depth":3},{"value":"Common Errors","id":"common-errors","depth":3},{"value":"Step 2: Preview Order","id":"step-2-preview-order","depth":2},{"value":"Endpoint","id":"endpoint-1","depth":3},{"value":"Request Parameters","id":"request-parameters-1","depth":3},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"Example Response","id":"example-response-1","depth":3},{"value":"Success Criteria","id":"success-criteria-1","depth":3},{"value":"Common Errors","id":"common-errors-1","depth":3},{"value":"Step 3: Create Order","id":"step-3-create-order","depth":2},{"value":"Endpoint","id":"endpoint-2","depth":3},{"value":"Request Parameters","id":"request-parameters-2","depth":3},{"value":"Example Request","id":"example-request-2","depth":3},{"value":"Example Response","id":"example-response-2","depth":3},{"value":"Success Criteria","id":"success-criteria-2","depth":3},{"value":"Common Errors","id":"common-errors-2","depth":3},{"value":"Step 4: Get Order Details","id":"step-4-get-order-details","depth":2},{"value":"Endpoint","id":"endpoint-3","depth":3},{"value":"Request Parameters","id":"request-parameters-3","depth":3},{"value":"Example Response","id":"example-response-3","depth":3},{"value":"Success Criteria","id":"success-criteria-3","depth":3},{"value":"Common Errors","id":"common-errors-3","depth":3},{"value":"Step 5: Export Order","id":"step-5-export-order","depth":2},{"value":"Endpoint","id":"endpoint-4","depth":3},{"value":"Request Parameters","id":"request-parameters-4","depth":3},{"value":"Example Response (200 - Ready)","id":"example-response-200---ready","depth":3},{"value":"Example Response (202 - Processing)","id":"example-response-202---processing","depth":3},{"value":"Success Criteria","id":"success-criteria-4","depth":3},{"value":"Common Errors","id":"common-errors-4","depth":3},{"value":"Implementation Notes","id":"implementation-notes","depth":2},{"value":"Polling Strategy for Order Completion","id":"polling-strategy-for-order-completion","depth":3},{"value":"Polling Strategy for Export Readiness","id":"polling-strategy-for-export-readiness","depth":3},{"value":"File Format Selection","id":"file-format-selection","depth":3}],"frontmatter":{"arazzo-workflow":"../../prospects_arazzo.yaml","workflow-id":"complete-prospects-order-workflow","test-automation":true,"workflow-type":"arazzo-1.0.1","seo":{"title":"Complete Prospects Order Workflow"}},"lastModified":"2026-07-22T15:23:01.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/connect-apis-catalog/product-catalog/prospects/documentation/processflows/completeprospectsorderworkflow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}